From 663ac610e3c85b64489686f5b3860b46db13ad7d Mon Sep 17 00:00:00 2001 From: Justin Foote Date: Wed, 5 Aug 2020 17:10:18 -0700 Subject: [PATCH 1/2] Add metric semantic conventions for timed operations --- ...mantic-conventions-for-timed-operations.md | 31 +++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 text/metrics/129-semantic-conventions-for-timed-operations.md diff --git a/text/metrics/129-semantic-conventions-for-timed-operations.md b/text/metrics/129-semantic-conventions-for-timed-operations.md new file mode 100644 index 000000000..9305a1242 --- /dev/null +++ b/text/metrics/129-semantic-conventions-for-timed-operations.md @@ -0,0 +1,31 @@ +# Semantic Conventions for Timed Operations + +## Motivation + +Timed operations are generally fully described by Spans. Because these Spans may be +sampled, aggregating information about them downstream is subject to inaccuracies. +Computing count, duration, and error rate from _all_ operations, regardless of whether +the result in a sampled Span, results in more accurate aggregates. + +## Explanation + +Summarization of timed operations may be done with a single `ValueRecorder`, onto which +the duration of each instance of the timed operation is recorded. + +### Naming + +The semantic conventions should specify the naming of this metric instrument, following +the [Metric Instrument Naming Guidelines](./108-naming-guidelines.md#guidelines). + +The goal of the semantic conventions regarding the naming of this metric instrument will +be that similar operations are rolled up together. + +### Labels + +The attributes described in the existing tracing semantic conventions provide guidance +for the labels to be added to this metric instrument. Some of these attributes will +result in very high cardinality; the semantic conventions should describe which attributes +should be included and which should be omitted or reformatted to reduce cardinality. + +In addition, the tracing attributes allow more value types than metric instrument labels, +so semantic conventions must describe how to represent those values as labels. From 0055e3159dfa3cd9ec93419a74013139102e7ccf Mon Sep 17 00:00:00 2001 From: Justin Foote Date: Mon, 10 Aug 2020 15:50:53 -0700 Subject: [PATCH 2/2] Fix link in otep 129 --- ...ons.md => 0129-semantic-conventions-for-timed-operations.md} | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) rename text/metrics/{129-semantic-conventions-for-timed-operations.md => 0129-semantic-conventions-for-timed-operations.md} (94%) diff --git a/text/metrics/129-semantic-conventions-for-timed-operations.md b/text/metrics/0129-semantic-conventions-for-timed-operations.md similarity index 94% rename from text/metrics/129-semantic-conventions-for-timed-operations.md rename to text/metrics/0129-semantic-conventions-for-timed-operations.md index 9305a1242..a3961dfe6 100644 --- a/text/metrics/129-semantic-conventions-for-timed-operations.md +++ b/text/metrics/0129-semantic-conventions-for-timed-operations.md @@ -15,7 +15,7 @@ the duration of each instance of the timed operation is recorded. ### Naming The semantic conventions should specify the naming of this metric instrument, following -the [Metric Instrument Naming Guidelines](./108-naming-guidelines.md#guidelines). +the [Metric Instrument Naming Guidelines](./0108-naming-guidelines.md#guidelines). The goal of the semantic conventions regarding the naming of this metric instrument will be that similar operations are rolled up together.