Details

    • Technical task
    • Status: Resolved
    • Major
    • Resolution: Fixed
    • None
    • vulcan
    • None
    • DOC-S15-May04, DOC-S17-Jun01, DOC-S18-Jun19, DOC-S19-Jun29, DOC-S20-Jul13[RC], DOC-S21-Jul20[Vulcan GA]
    • 1

    Description

      We need Threshold logging / tracing docs for each individual SDK. There are some links in Matt's blog post.

      Take a look at https://developer.couchbase.com/documentation/server/5.5/sdk/dotnet/threshold-logging.html and note any differences; we need:

      1. Any differences in Threshold Configuration Settings
      2. An example along the lines of Michael's blog post.

      I'll merge this into a new doc.

      Also need to make sure that the examples in each SDK's docs cover the points from DOC-3102:

      • document new timing info coming from server
      • setting "slow operation" threshold on client
      • setting "slow operation" threshold on server
      • example of saving slow operations to client logs
      • example of capturing client timing to get an overall timing of operation

      Attachments

        Issue Links

          No reviews matched the request. Check your Options in the drop-down menu of this sections header.

          Activity

            Updates to config settings are in https://github.com/couchbase/docs-cb4/blob/vulcan/content/sdk/shared/tracing.dita

            They should be pulled into each SDK's doc automatically. Into http://docs-build.sc.couchbase.com/server/2570/sdk/java/threshold-logging.html & equivalent.
            (the above isn't showing the updated config yet).

            HOWTO up at http://docs-build.sc.couchbase.com/server/2570/sdk/java/tracing-from-the-sdk.html

            Above two are up at: https://github.com/couchbase/docs-cb4/pull/2570

             

            What's needed for the Node SDK is a snippet for the bottom of the threshold-logging page.
            & either:

            i) A drop in replacement set of code (and comments) for the tracing-from-the-SDK linked above. or

            ii) Something that better fits this SDK. or

            iii) [if really pushed for time] A commented code sample showing something useful that the SDK can do with Threshold logging.

             

            Thank you! 

            richard.smedley Richard Smedley added a comment - Updates to config settings are in https://github.com/couchbase/docs-cb4/blob/vulcan/content/sdk/shared/tracing.dita They should be pulled into each SDK's doc automatically. Into http://docs-build.sc.couchbase.com/server/2570/sdk/java/threshold-logging.html  & equivalent. (the above isn't showing the updated config yet). HOWTO up at http://docs-build.sc.couchbase.com/server/2570/sdk/java/tracing-from-the-sdk.html Above two are up at: https://github.com/couchbase/docs-cb4/pull/2570   What's needed for the Node SDK is a snippet for the bottom of the threshold-logging page. & either: i) A drop in replacement set of code (and comments) for the tracing-from-the-SDK linked above. or ii) Something that better fits this SDK. or iii) [if really pushed for time] A commented code sample showing something useful that the SDK can do with Threshold logging.   Thank you! 

            Hey Richard Smedley,

            The Node.js SDK strictly depends on the C SDK for its tracing configuration and behaviour.  It's likely that the C SDK's page will be identical.  We should either refer Node.js users to that page, duplicate the page, or possibly make slight alterations to it to ensure it makes sense for Node.js users still.  I believe PHP will fall into a similar situation.

            Cheers, Brett

            brett19 Brett Lawson added a comment - Hey Richard Smedley , The Node.js SDK strictly depends on the C SDK for its tracing configuration and behaviour.  It's likely that the C SDK's page will be identical.  We should either refer Node.js users to that page, duplicate the page, or possibly make slight alterations to it to ensure it makes sense for Node.js users still.  I believe PHP will fall into a similar situation. Cheers, Brett

            People

              richard.smedley Richard Smedley
              richard.smedley Richard Smedley
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Gerrit Reviews

                  There are no open Gerrit changes

                  PagerDuty