Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Brief Project Overview (brief as it should be known)

  1. Logging deploys an ELK stack set of containers via OOM (Logstash, ElasticSearch and Kibana) - selected onap components add a filebeat sidecar container to ship/stream formatted logs to this elk stack - see the diagram with the small boxes streaming logs to this ELK stack.

    Image Added
  2. New component capabilities for Dublin, i.e. the functional enhancements.
      1. get as many projects as possible to adopt the casablanca logging guidelines ONAP Application Logging Specification v1.2 (Casablanca)
      2. work on the dublin logging guidelines changes for adoption in elalto - minimal so far ONAP Application Logging Specification - Post Dublin
      3. prometheus work was slated but has been moved to the OOM scope
        Jira Legacy
        serverONAP JIRA
        serverId425b2b0a-557c-3c0c-b515-579789cceedb
        keyLOG-911
         via 
        Jira Legacy
        serverONAP JIRA
        serverId425b2b0a-557c-3c0c-b515-579789cceedb
        keyOOM-1502
      4. see Logging Dublin Scope
  3. New or modified interfaces
        1. none
  4. If they are modified, are the backwards compatible?
  5. Interface naming (point to an example)
    1. There are no actual interfaces (no REST ones) - there is a logging specification - how the projects get there is usually a jar - we have provided a spring based AOP jar https://git.onap.org/logging-analytics/tree/reference/logging-library and an example war https://git.onap.org/logging-analytics/tree/reference/logging-demo
    2. There are ELK ports - specifically the logstash:5044 port - most projects stream logs to this port - there is an example of how to do this in https://git.onap.org/logging-analytics/tree/reference/logging-kubernetes
    3. there are at least 4 logging libraries in portal/sdk, so, aai - for now projects just use their own AOP or non-AOP jar - there is an example reference since early casablanca in Logging Developer Guide#JAVA:AddingLoggingtoaWARProject - but the plan for Dublin was (more likely Elalto) - to adjust the portal/sdk library to use the proposed spec - then we get a couple projects for free as we work on the remainders - 
      Jira Legacy
      serverONAP JIRA
      serverId425b2b0a-557c-3c0c-b515-579789cceedb
      keyLOG-600
  6. Reference to the interfaces.

  7. What are the system limits?

    H/A using Kubernetes, will need pod anti-affinity rules for some components like AAI (AAI and logstash not on the same K8S cluster VM).

  8. Involved use cases, architectural capabilities or functional requirements.
      1. Any that cause transaction logs in any ONAP component currently streaming logs
      2. not to be confused with the CLAMP elk stack
  9. Listing of new or impacted models used by the project (for information only).
      1. None