Page Status: Copied from Guilin-R7 - Aug-24-2020
Component Status: Pending PTL updates and ArchCom Review
Last Reviewed on:
Certified by:
Logging :
1 High Level Component Definition and Architectural Relationships
eyJleHRTcnZJbnRlZ1R5cGUiOiIiLCJnQ2xpZW50SWQiOiIiLCJjcmVhdG9yTmFtZSI6IkNoYWtlciBBbC1IYWtpbSIsIm91dHB1dFR5cGUiOiJibG9jayIsImxhc3RNb2RpZmllck5hbWUiOiJCeXVuZy1Xb28gSnVuIiwibGFuZ3VhZ2UiOiJlbiIsImRpYWdyYW1EaXNwbGF5TmFtZSI6IiIsInNGaWxlSWQiOiIiLCJhdHRJZCI6IjkzMDEyNDcxIiwiZGlhZ3JhbU5hbWUiOiJsb2dnaW5nX3I3IiwiYXNwZWN0IjoiIiwibGlua3MiOiJhdXRvIiwiY2VvTmFtZSI6IkFSQyBMb2dnaW5nIENvbXBvbmVudCBEZXNjcmlwdGlvbiAtIElzdGFuYnVsLVI5ICIsInRic3R5bGUiOiJ0b3AiLCJjYW5Db21tZW50IjpmYWxzZSwiZGlhZ3JhbVVybCI6IiIsImNzdkZpbGVVcmwiOiIiLCJib3JkZXIiOnRydWUsIm1heFNjYWxlIjoiMSIsIm93bmluZ1BhZ2VJZCI6OTMwMTI0NzAsImVkaXRhYmxlIjpmYWxzZSwiY2VvSWQiOjEwMDg5MzA1MywicGFnZUlkIjoiIiwibGJveCI6dHJ1ZSwic2VydmVyQ29uZmlnIjp7ImVtYWlscHJldmlldyI6IjEifSwib2RyaXZlSWQiOiIiLCJyZXZpc2lvbiI6MSwibWFjcm9JZCI6IjdiZDg0YTRiLTU2OTMtNDhkNy1hNWFiLTY3OGI4ZTQ5Nzg5YiIsInByZXZpZXdOYW1lIjoibG9nZ2luZ19yNy5wbmciLCJsaWNlbnNlU3RhdHVzIjoiT0siLCJzZXJ2aWNlIjoiIiwiaXNUZW1wbGF0ZSI6IiIsIndpZHRoIjoiODAxIiwic2ltcGxlVmlld2VyIjpmYWxzZSwibGFzdE1vZGlmaWVkIjoxNjE2NDQxOTgyMDAwLCJleGNlZWRQYWdlV2lkdGgiOmZhbHNlLCJvQ2xpZW50SWQiOiIifQ==
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
eyJleHRTcnZJbnRlZ1R5cGUiOiIiLCJnQ2xpZW50SWQiOiIiLCJjcmVhdG9yTmFtZSI6IkNoYWtlciBBbC1IYWtpbSIsIm91dHB1dFR5cGUiOiJibG9jayIsImxhc3RNb2RpZmllck5hbWUiOiJDaGFrZXIgQWwtSGFraW0iLCJsYW5ndWFnZSI6ImVuIiwiZGlhZ3JhbURpc3BsYXlOYW1lIjoiIiwic0ZpbGVJZCI6IiIsImF0dElkIjoiOTMwMTI0NzQiLCJkaWFncmFtTmFtZSI6IkxPR0dJTkcgcnVudGltZSBhcmNoaXRlY3RydWUiLCJhc3BlY3QiOiIiLCJsaW5rcyI6ImF1dG8iLCJjZW9OYW1lIjoiQVJDIExvZ2dpbmcgQ29tcG9uZW50IERlc2NyaXB0aW9uIC0gSXN0YW5idWwtUjkgIiwidGJzdHlsZSI6InRvcCIsImNhbkNvbW1lbnQiOmZhbHNlLCJkaWFncmFtVXJsIjoiIiwiY3N2RmlsZVVybCI6IiIsImJvcmRlciI6dHJ1ZSwibWF4U2NhbGUiOiIxIiwib3duaW5nUGFnZUlkIjo5MzAxMjQ3MCwiZWRpdGFibGUiOmZhbHNlLCJjZW9JZCI6MTAwODkzMDUzLCJwYWdlSWQiOiIiLCJsYm94Ijp0cnVlLCJzZXJ2ZXJDb25maWciOnsiZW1haWxwcmV2aWV3IjoiMSJ9LCJvZHJpdmVJZCI6IiIsInJldmlzaW9uIjoxLCJtYWNyb0lkIjoiYjE2ZTIyY2EtOGM0Mi00ZjUxLTg1OGYtMzMyNTZmYzM3MDU0IiwicHJldmlld05hbWUiOiJMT0dHSU5HIHJ1bnRpbWUgYXJjaGl0ZWN0cnVlLnBuZyIsImxpY2Vuc2VTdGF0dXMiOiJPSyIsInNlcnZpY2UiOiIiLCJpc1RlbXBsYXRlIjoiIiwid2lkdGgiOiIyMzkiLCJzaW1wbGVWaWV3ZXIiOmZhbHNlLCJsYXN0TW9kaWZpZWQiOjE2MTQ4NzYwMTQwMDAsImV4Y2VlZFBhZ2VXaWR0aCI6ZmFsc2UsIm9DbGllbnRJZCI6IiJ9
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