DRAFT IF ARC Logging Component Description - Dublin (Copy)

Owned by Chaker Al-Hakim
Last updated: Apr 28, 2020
1 min read

STATUS: Draft -

Logging :

1 High Level Component Definition and Architectural Relationships 



TODO: Capture the components that can export to logging

The Logging functional entity provides the capability capture information required to operate, troubleshoot and report on the performance of the ONAP platform.  It can :

  • Display logging analytics

  • Provide centralized logging information from distributed ONAP components

  • Coorelate and track a external client request as it traverses the ONAP components.

Note: The logging data reception information is provided by the support of the logging source using a component.  

2. API definitions

LOGGING provides the following interfaces:

Interface Name

Interface Definition

 Interface Capabilities

Interface Name

Interface Definition

 Interface Capabilities

LOGE-1

Logging data reception interface

Provides the ability of the logging source to export logged data

LOGE-2

Logging Anaytics visulization interface

Provides the ability to display and query logging information.

Note:   xxxI interface is a Component internal interface.  xxxxE interface is a component external interface

The current API documents can be found at:

As the LOGE-1 interfaces is a replication of internally stored log data, there is not a specification interface in a traditional sense.  Logging guidelines can be found at: https://docs.onap.org/en/casablanca/submodules/logging-analytics.git/docs/Logging_Enhancements_Project/logging_enhancements_project.html?highlight=log



Logging consumes the following Interfaces:

Interface Name

Purpose Reason For Use

Interface Name

Purpose Reason For Use

-

-



3. Component Description:

A more detailed figure and description of the component.

<< For later inclusion >>

4. known system limitations

-

5. Used Models

-

6. System Deployment Architecture



Logging consists of 3 containers:

elasticsearch

logstach

kibana



7. New Capabilities in this Release

This release, LOGGING adds the following Capabilities:

  • Add prometheus charts for kubernetes metric streaming

  • Support for more projects 

8. References

 Logging Guide: https://docs.onap.org/en/casablanca/submodules/logging-analytics.git/docs/Logging_Enhancements_Project/logging_enhancements_project.html?highlight=log