STATUS: Draft -
Logging :
1 High Level Component Definition and Architectural Relationships
eyJleHRTcnZJbnRlZ1R5cGUiOiIiLCJnQ2xpZW50SWQiOiIiLCJjcmVhdG9yTmFtZSI6IkNoYWtlciBBbC1IYWtpbSIsIm91dHB1dFR5cGUiOiJibG9jayIsImxhc3RNb2RpZmllck5hbWUiOiJDaGFrZXIgQWwtSGFraW0iLCJsYW5ndWFnZSI6ImVuIiwiZGlhZ3JhbURpc3BsYXlOYW1lIjoiIiwic0ZpbGVJZCI6IiIsImF0dElkIjoiODQ2NDE1MDAiLCJkaWFncmFtTmFtZSI6IkxvZ2dpbmcgU3lzdGVtIENvbnRleHQgVmlldyIsImFzcGVjdCI6IiIsImxpbmtzIjoiYXV0byIsImNlb05hbWUiOiJEUkFGVCBJRiBBUkMgTG9nZ2luZyBDb21wb25lbnQgRGVzY3JpcHRpb24gLSBEdWJsaW4gKENvcHkpIiwidGJzdHlsZSI6InRvcCIsImNhbkNvbW1lbnQiOmZhbHNlLCJkaWFncmFtVXJsIjoiIiwiY3N2RmlsZVVybCI6IiIsImJvcmRlciI6dHJ1ZSwibWF4U2NhbGUiOiIxIiwib3duaW5nUGFnZUlkIjo4NDY0MTQ5NiwiZWRpdGFibGUiOmZhbHNlLCJjZW9JZCI6ODQ2NDE0OTYsInBhZ2VJZCI6IiIsImxib3giOnRydWUsInNlcnZlckNvbmZpZyI6eyJlbWFpbHByZXZpZXciOiIxIn0sIm9kcml2ZUlkIjoiIiwicmV2aXNpb24iOjEsIm1hY3JvSWQiOiJhNDAwYzQ0OS0xZDEwLTRhMjYtOWY2Zi1kOGQxMmY2ZWUyNDgiLCJwcmV2aWV3TmFtZSI6IkxvZ2dpbmcgU3lzdGVtIENvbnRleHQgVmlldy5wbmciLCJsaWNlbnNlU3RhdHVzIjoiT0siLCJzZXJ2aWNlIjoiIiwiaXNUZW1wbGF0ZSI6IiIsIndpZHRoIjoiNzM3Iiwic2ltcGxlVmlld2VyIjpmYWxzZSwibGFzdE1vZGlmaWVkIjoxNTg4MDk1MzM5MDAwLCJleGNlZWRQYWdlV2lkdGgiOmZhbHNlLCJvQ2xpZW50SWQiOiIifQ==
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 |
---|
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 |
---|
- | - |
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
eyJleHRTcnZJbnRlZ1R5cGUiOiIiLCJnQ2xpZW50SWQiOiIiLCJjcmVhdG9yTmFtZSI6IkNoYWtlciBBbC1IYWtpbSIsIm91dHB1dFR5cGUiOiJibG9jayIsImxhc3RNb2RpZmllck5hbWUiOiJDaGFrZXIgQWwtSGFraW0iLCJsYW5ndWFnZSI6ImVuIiwiZGlhZ3JhbURpc3BsYXlOYW1lIjoiIiwic0ZpbGVJZCI6IiIsImF0dElkIjoiODQ2NDE0OTgiLCJkaWFncmFtTmFtZSI6IkxPR0dJTkcgcnVudGltZSBhcmNoaXRlY3RydWUiLCJhc3BlY3QiOiIiLCJsaW5rcyI6ImF1dG8iLCJjZW9OYW1lIjoiRFJBRlQgSUYgQVJDIExvZ2dpbmcgQ29tcG9uZW50IERlc2NyaXB0aW9uIC0gRHVibGluIChDb3B5KSIsInRic3R5bGUiOiJ0b3AiLCJjYW5Db21tZW50IjpmYWxzZSwiZGlhZ3JhbVVybCI6IiIsImNzdkZpbGVVcmwiOiIiLCJib3JkZXIiOnRydWUsIm1heFNjYWxlIjoiMSIsIm93bmluZ1BhZ2VJZCI6ODQ2NDE0OTYsImVkaXRhYmxlIjpmYWxzZSwiY2VvSWQiOjg0NjQxNDk2LCJwYWdlSWQiOiIiLCJsYm94Ijp0cnVlLCJzZXJ2ZXJDb25maWciOnsiZW1haWxwcmV2aWV3IjoiMSJ9LCJvZHJpdmVJZCI6IiIsInJldmlzaW9uIjoxLCJtYWNyb0lkIjoiYzYwMTc5YzMtMjY4Ny00ZmVkLWJmMDUtZTliMzBlN2ZmMzU5IiwicHJldmlld05hbWUiOiJMT0dHSU5HIHJ1bnRpbWUgYXJjaGl0ZWN0cnVlLnBuZyIsImxpY2Vuc2VTdGF0dXMiOiJPSyIsInNlcnZpY2UiOiIiLCJpc1RlbXBsYXRlIjoiIiwid2lkdGgiOiIyMzkiLCJzaW1wbGVWaWV3ZXIiOmZhbHNlLCJsYXN0TW9kaWZpZWQiOjE1ODgwOTUzMzkwMDAsImV4Y2VlZFBhZ2VXaWR0aCI6ZmFsc2UsIm9DbGllbnRJZCI6IiJ9
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