Uploaded image for project: 'Couchbase Server'
  1. Couchbase Server
  2. MB-5304

stats for key are not defined in documentation, many stats are not defined

    Details

    • Flagged:
      Impediment

      Description

      To work through the implementation of OBSERVE[1], we were looking for the details on STATS KEY, only to find it's not documented. It exists in the server implementation, but it's not even in the stats.org[2] associated with the code repository.

      This statistic and all others that are public interface should be documented in the manual.

      Implementation of OBSERVE operations in the various client libraries will need this information.

      1. http://www.couchbase.com/wiki/display/couchbase/Observe
      2. https://github.com/couchbase/ep-engine/blob/master/docs/stats.org

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

        Activity

        Hide
        mikew Mike Wiederhold added a comment -

        K = Key
        V = VKey

        And key_valid is not included in stats key.

        Show
        mikew Mike Wiederhold added a comment - K = Key V = VKey And key_valid is not included in stats key.
        Hide
        avsej Sergey Avseyev added a comment -

        What does mean "is not included in stats"? I can have key "x" with value "test" in the default bucket on couchbase 2.0. Here is the output of the command line tools:

        $ cbc cat x
        "x" Size 5 Flags 0x0 CAS 0x69cf70ff8de90000
        test
        $ curl -s http://localhost:8091/pools/default/buckets/default | vbuckettool - x
        key: x master: 127.0.0.1:11210 vBucketId: 220 couchApiBase: http://127.0.0.1:8092/default replicas:
        $ cbc stats "key x 220"
        127.0.0.1:11210 key_is_dirty 0
        127.0.0.1:11210 key_exptime 0
        127.0.0.1:11210 key_flags 0
        127.0.0.1:11210 key_cas 256796085243753
        127.0.0.1:11210 key_dirtied 0
        127.0.0.1:11210 key_data_age 0
        127.0.0.1:11210 key_last_modification_time 1338826758
        $ cbc stats "vkey x 220"
        127.0.0.1:11210 key_is_dirty 0
        127.0.0.1:11210 key_exptime 0
        127.0.0.1:11210 key_flags 0
        127.0.0.1:11210 key_cas 256796085243753
        127.0.0.1:11210 key_dirtied 0
        127.0.0.1:11210 key_data_age 0
        127.0.0.1:11210 key_last_modification_time 1338826854
        127.0.0.1:11210 key_valid valid

        You can see the last line says there is key "key_valid" and value "valid"

        Show
        avsej Sergey Avseyev added a comment - What does mean "is not included in stats"? I can have key "x" with value "test" in the default bucket on couchbase 2.0. Here is the output of the command line tools: $ cbc cat x "x" Size 5 Flags 0x0 CAS 0x69cf70ff8de90000 test $ curl -s http://localhost:8091/pools/default/buckets/default | vbuckettool - x key: x master: 127.0.0.1:11210 vBucketId: 220 couchApiBase: http://127.0.0.1:8092/default replicas: $ cbc stats "key x 220" 127.0.0.1:11210 key_is_dirty 0 127.0.0.1:11210 key_exptime 0 127.0.0.1:11210 key_flags 0 127.0.0.1:11210 key_cas 256796085243753 127.0.0.1:11210 key_dirtied 0 127.0.0.1:11210 key_data_age 0 127.0.0.1:11210 key_last_modification_time 1338826758 $ cbc stats "vkey x 220" 127.0.0.1:11210 key_is_dirty 0 127.0.0.1:11210 key_exptime 0 127.0.0.1:11210 key_flags 0 127.0.0.1:11210 key_cas 256796085243753 127.0.0.1:11210 key_dirtied 0 127.0.0.1:11210 key_data_age 0 127.0.0.1:11210 key_last_modification_time 1338826854 127.0.0.1:11210 key_valid valid You can see the last line says there is key "key_valid" and value "valid"
        Hide
        avsej Sergey Avseyev added a comment - - edited

        I see now sorry. VKey. So I have no objections any more

        Show
        avsej Sergey Avseyev added a comment - - edited I see now sorry. VKey. So I have no objections any more
        Hide
        mikew Mike Wiederhold added a comment -

        Sergey appears to be okay with the documentation. PLease reopen if any other issues come up.

        Show
        mikew Mike Wiederhold added a comment - Sergey appears to be okay with the documentation. PLease reopen if any other issues come up.
        Hide
        ingenthr Matt Ingenthron added a comment -

        My confusion too was based on the last column. Could we clarify that (if not done already)? I thought you were saying whether or not each stat returned a key and value for the stat.

        Show
        ingenthr Matt Ingenthron added a comment - My confusion too was based on the last column. Could we clarify that (if not done already)? I thought you were saying whether or not each stat returned a key and value for the stat.

          People

          • Assignee:
            mikew Mike Wiederhold
            Reporter:
            ingenthr Matt Ingenthron
          • Votes:
            1 Vote for this issue
            Watchers:
            4 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Gerrit Reviews

              There are no open Gerrit changes