aboutsummaryrefslogtreecommitdiffhomepage
path: root/include/grpc/census.h
diff options
context:
space:
mode:
authorGravatar Alistair Veitch <aveitch@google.com>2016-01-19 13:56:52 -0800
committerGravatar Alistair Veitch <aveitch@google.com>2016-01-19 13:56:52 -0800
commit4bbdb825677bde8e53cbab58ad4193c505dc9a50 (patch)
treebe972a1d45575a2ac701e4c65bd243cf6a379988 /include/grpc/census.h
parent0923126cf85a83dab29bbd21f66c5df1f9a56bf8 (diff)
comment updates
Diffstat (limited to 'include/grpc/census.h')
-rw-r--r--include/grpc/census.h24
1 files changed, 13 insertions, 11 deletions
diff --git a/include/grpc/census.h b/include/grpc/census.h
index 7b769c62ee..4b3d021410 100644
--- a/include/grpc/census.h
+++ b/include/grpc/census.h
@@ -329,12 +329,14 @@ void census_trace_scan_end();
a tag set. All contexts have an associated tag set. */
typedef struct census_tag_set census_tag_set;
-/* A tag is a key:value pair. The key is a non-empty, printable, nil-terminated
- string. The value is a binary string, that may be printable. There are no
- limits on the sizes of either keys or values, but code authors should
- remember that systems may have inbuilt limits (e.g. for propagated tags,
- the bytes on the wire) and that larger tags means more memory consumed and
- time in processing. */
+/* A tag is a key:value pair. The key is a non-empty, printable (UTF-8
+ encoded), nil-terminated string. The value is a binary string, that may be
+ printable. There are limits on the sizes of both keys and values (see
+ CENSUS_MAX_TAG_KB_LEN definition below), and the number of tags that can be
+ propagated (CENSUS_MAX_PROPAGATED_TAGS). Users should also remember that
+ some systems may have limits on, e.g., the number of bytes that can be
+ transmitted as metadata, and that larger tags means more memory consumed
+ and time in processing. */
typedef struct {
const char *key;
const char *value;
@@ -342,6 +344,11 @@ typedef struct {
uint8_t flags;
} census_tag;
+/* Maximum length of a tag's key or value. */
+#define CENSUS_MAX_TAG_KV_LEN 255
+/* Maximum number of propagatable tags. */
+#define CENSUS_MAX_PROPAGATED_TAGS 255
+
/* Tag flags. */
#define CENSUS_TAG_PROPAGATE 1 /* Tag should be propagated over RPC */
#define CENSUS_TAG_STATS 2 /* Tag will be used for statistics aggregation */
@@ -354,11 +361,6 @@ typedef struct {
#define CENSUS_TAG_IS_STATS(flags) (flags & CENSUS_TAG_STATS)
#define CENSUS_TAG_IS_BINARY(flags) (flags & CENSUS_TAG_BINARY)
-/* Maximum length of key/value in a tag. */
-#define CENSUS_MAX_TAG_KV_LEN 255
-/* Maximum number of propagatable tags. */
-#define CENSUS_MAX_PROPAGATED_TAGS 255
-
typedef struct {
int n_propagated_tags; /* number of propagated printable tags */
int n_propagated_binary_tags; /* number of propagated binary tags */