Uploaded image for project: 'Nuxeo Platform'
  1. Nuxeo Platform
  2. NXP-29940

Add a management endpoint for Stream introspection

    XMLWordPrintable

    Details

    • Type: New Feature
    • Status: Resolved
    • Priority: Minor
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 11.5, 2021.0
    • Component/s: Streams
    • Epic Link:
    • Tags:
    • Upgrade notes:
      Hide

      You can now introspect the Nuxeo Stream configuration and state for an entire cluster:
      First configure your Nuxeo with:

      metrics.enabled=true
metrics.streams.enabled=true

      A JSON representation is available at the following endpoint:

      curl -u Administrator:Administrator http://nuxeo.docker.localhost/nuxeo/api/v1/management/stream

      It is also available as a PUML representation

      curl -u Administrator:Administrator http://nuxeo.docker.localhost/nuxeo/api/v1/management/stream/puml/ > /tmp/streams.puml

      A SVG chart can be generated using plantuml.jar:

      java  -DPLANTUML_LIMIT_SIZE=16384  -jar ~/Downloads/plantuml.jar /tmp/streams.puml -tsvg
      Show
      You can now introspect the Nuxeo Stream configuration and state for an entire cluster: First configure your Nuxeo with: metrics.enabled= true metrics.streams.enabled= true A JSON representation is available at the following endpoint: curl -u Administrator:Administrator http: //nuxeo.docker.localhost/nuxeo/api/v1/management/stream It is also available as a PUML representation curl -u Administrator:Administrator http: //nuxeo.docker.localhost/nuxeo/api/v1/management/stream/puml/ > /tmp/streams.puml A SVG chart can be generated using plantuml.jar : java -DPLANTUML_LIMIT_SIZE=16384 -jar ~/Downloads/plantuml.jar /tmp/streams.puml -tsvg
    • Team:
      PLATFORM
    • Sprint:
      nxplatform #23
    • Story Points:
      1

      Description

      Add a REST endpoint to expose the Stream introspection,
      this should be exposed as JSON, eventually as PUML

        Attachments

        1. streams.json
          38 kB
        2. streams.puml
          15 kB
        3. streams.svg
          164 kB

          Issue Links

          is related to

          Bug - A problem which impairs or prevents the functions of the product. NXP-29961 In Stream introspection PUML/SVG the lag is not displayed

          • Minor - Minor loss of function, or other problem where easy workaround is present.
          • Resolved
          Is referenced in

          [Captain Hook] PR for 2021: #26 PR for 2021: #26

          [Captain Hook] PR for master: #4518 PR for master: #4518

          [Captain Hook] PR for master: #4534 PR for master: #4534

            Activity

              People

              • Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:

                  Time Tracking

                  Estimated:
                  Original Estimate - Not Specified
                  Not Specified
                  Remaining:
                  Remaining Estimate - 0 minutes
                  0m
                  Logged:
                  Time Spent - 1 day
                  1d