Aaron Abbott
c26513af33
Use "example.com" where an example domain is needed ( #465 )
2 years ago
Tigran Najaryan
46152b8c49
Eliminate nested "protocol" directory and fix all links
...
The "protocol" sub-directory is superfluous, I just moved all the files
to the "specification" directory.
Fixed all links, used relative links to files in this repo.
TODO: add link checker in another PR.
2 years ago
Jonatan Ivanov
eb214e0cea
Declare OTLP stable ( #3274 )
2 years ago
Evan Mattson
c199321d92
Fix typos and grammar in the OTLP spec ( #3121 )
2 years ago
Tigran Najaryan
7e0f31ab0f
Declare OTLP/JSON Stable ( #2930 )
...
See also https://github.com/open-telemetry/opentelemetry-proto/pull/436
Co-authored-by: Carlos Alberto Cortez <calberto.cortez@gmail.com>
2 years ago
Peter Deng
949095b110
Add table for OTLP/HTTP response code and client retry recommendation ( #3028 )
2 years ago
Tigran Najaryan
5a5e750bf9
Clarify that lowerCamelCase field names MUST be used for OTLP/JSON ( #2829 )
...
Resolves https://github.com/open-telemetry/opentelemetry-specification/issues/2795
This is a breaking change for OTLP/JSON and is allowed because OTLP/JSON is not yet Stable.
2 years ago
Tigran Najaryan
89968ffffb
Clarify that unknown fields must be ignored when receiving OTLP/JSON ( #2816 )
...
* Clarify that unknown fields must be ignored when receiving OTLP/JSON
Resolves https://github.com/open-telemetry/opentelemetry-proto/issues/425
The proposed behavior is necessary for interoperability of senders and receivers
when OTLP protocol evolves in an allowed way: by adding new fields to existing
messages.
* Remove unnecessary sentence
* Fix typo
Co-authored-by: Yuri Shkuro <yurishkuro@users.noreply.github.com>
2 years ago
Tigran Najaryan
ec7ea3de77
Prohibit usage of enum value name strings in OTLP/JSON ( #2758 )
...
* Prohibit usage of enum value name strings in OTLP/JSON
Resolves https://github.com/open-telemetry/opentelemetry-proto/issues/424
This change disallows using enum value names as strings
in OTLP/JSON and requires to use enum integer values only.
* Fix grammar
Co-authored-by: Bogdan Drutu <bogdandrutu@gmail.com>
2 years ago
Tigran Najaryan
5799349f74
Refactor OTLP/HTTP section ( #2756 )
...
Make Binary and JSON encodings their own sections.
This makes the spec easier to understand and also
makes adding further clarifications to JSON easier.
There are no functional changes. OTLP protocol behavior
remains exactly the same. This is purely editorial change.
2 years ago
Gustavo Pantuza
8219c68fcb
Inserts links to each Protocol Buffer definition by Telemetry signal ( #2723 )
2 years ago
Joao Grassi
810bdf06e1
Add support for partial success in an OTLP export response [2] ( #2696 )
2 years ago
Tigran Najaryan
ca893c89e3
Mark OTLP Logs Stable ( #2565 )
2 years ago
Stepan Rakitin
be24591c02
Retry RESOURCE_EXHAUSTED only if the server can recover ( #2480 )
2 years ago
Patrice Chalin
371f7c7864
Fix formatting of OTLP/HTTP's two status lines ( #2442 )
2 years ago
Nicholas Volker
1911026b70
Duplicate word removal ( #2423 )
2 years ago
Patrice Chalin
202993e258
Ensure all ToCs are generated using markdown-toc ( #2146 )
2 years ago
Tigran Najaryan
0e7bd37390
Change OTLP/HTTP port from 4317 to 4318 ( #1839 ) ( #1970 )
...
Related to https://github.com/open-telemetry/opentelemetry-specification/issues/1816
Fixes https://github.com/open-telemetry/opentelemetry-specification/issues/1835
Fixes https://github.com/open-telemetry/opentelemetry-specification/issues/1920
Some historical context: we wanted to make grpc and http use the same port and we
had an open issue in the Collector to do so:
https://github.com/open-telemetry/opentelemetry-collector/issues/1256
The conclusion is that there are technical hurdles that make it unfeasible:
https://github.com/open-telemetry/opentelemetry-collector/issues/1256#issuecomment-880048833
Because of that we need to keep grpc and http ports separate. This means we need to
change the spec to say that otlp/http uses port 4318. Once this PR is merged we
will also need to submit for port 4318 registration with IANA like we did previously
with port 4317:
https://github.com/open-telemetry/opentelemetry-specification/issues/1148#issuecomment-725067404
There was also a draft PR to merge the ports in the Collector but it was not completed:
https://github.com/open-telemetry/opentelemetry-collector/pull/3765
Note that this change was initially submitted in PR https://github.com/open-telemetry/opentelemetry-specification/pull/1839
and then reverted in PR https://github.com/open-telemetry/opentelemetry-specification/pull/1847
because we hoped that the merging could be successfully done. We believe that we should
no longer pursue this and should consider the ports separate from now on.
Note 2: we consider this a spec bug fix (spec was impossible to implement), rather than a
functionality change, that's why we believe this is an allowed change.
2 years ago
Carlos Alberto Cortez
fb390fdcd6
Clarify OTLP server components MUST support none/gzip compression. ( #1955 )
2 years ago
Tigran Najaryan
f9cdd6b36e
Revert "Change OTLP/HTTP port from 4317 to 4318 ( #1839 )" ( #1847 )
...
Apparently there is new evidence that one port may work after all:
https://github.com/open-telemetry/opentelemetry-collector/pull/3765/files
This reverts commit cce1d5996873de38a68e05eafa4d5e224df9b8f1 until we have the final
decision about the ability to have a single port, see:
https://github.com/open-telemetry/opentelemetry-specification/issues/1846#issuecomment-892523208
2 years ago
Tigran Najaryan
afed9b5509
Change OTLP/HTTP port from 4317 to 4318 ( #1839 )
...
Related to https://github.com/open-telemetry/opentelemetry-specification/issues/1816
Fixes https://github.com/open-telemetry/opentelemetry-specification/issues/1835
Some historical context: we wanted to make grpc and http use the same port and we
had an open issue in the Collector to do so:
https://github.com/open-telemetry/opentelemetry-collector/issues/1256
The conclusion is that there are technical hurdles that make it unfeasible:
https://github.com/open-telemetry/opentelemetry-collector/issues/1256#issuecomment-880048833
Because of that we need to keep grpc and http ports separate. This means we need to
change the spec to say that otlp/http uses port 4318. Once this PR is merged we
will also need to submit for port 4318 registration with IANA like we did previously
with port 4317:
https://github.com/open-telemetry/opentelemetry-specification/issues/1148#issuecomment-725067404
2 years ago
Tigran Najaryan
1b95a502ab
Declare OTLP Logs Beta ( #1741 )
...
The Log SIG discussed and made a decision to declare Log data model
and Log part of OTLP Beta.
(See SIG meeting notes here https://docs.google.com/document/d/1cX5fWXyWqVVzYHSFUymYUfWxUK5hT97gc23w595LmdM/edit#heading=h.28y76as82bvu )
2 years ago
Josh Suereth
b61134c803
Mark relevant portions of Metrics DataModel stable ( #1728 )
...
* Mark sections of datamodel stable.
* Generated ToC
* Clean up MUST and SHOULD in the document.
* adjust for bug in markdown-toc
* Mark protocol as stable.
Co-authored-by: Carlos Alberto Cortez <calberto.cortez@gmail.com>
2 years ago
Tigran Najaryan
cf481d4449
Clarify that 64 bit integer numbers are decimal strings in OTLP/JSON ( #1637 )
...
Resolves https://github.com/open-telemetry/opentelemetry-proto/issues/268
This behavior is already the documented behavior for JSON Protobuf,
see https://developers.google.com/protocol-buffers/docs/proto3#json :
>JSON value will be a decimal string. Either numbers or strings are accepted.
2 years ago
Carlos Alberto Cortez
aec59b9d90
OTLP stability clarifications ( #1400 )
2 years ago
Ted Young
56ef4bc0a3
Add lifecycle statuses to all documents ( #1385 )
2 years ago
Bogdan Drutu
919a940049
Update links/github actions after the master -> main rename ( #1384 )
...
Signed-off-by: Bogdan Drutu <bogdandrutu@gmail.com>
2 years ago
Ted Young
3008c766b6
Versioning and Stability for OpenTelemetry ( #1291 )
...
* Versioning and support based on OTEP 143
2 years ago
Zhongyang Wu
1198c0a563
fix: otlp.md missing closing details label. ( #1278 )
...
## Changes
It seems wired that the closing tag of `<details>` is missing. As a result, most of the content has been folded.
Added a closing `</details>` tags to only fold the table of contents.
Before the change:
![image](https://user-images.githubusercontent.com/12531298/101312037-ccbd5080-3820-11eb-89d0-e153de96dacd.png )
After the change:
![image](https://user-images.githubusercontent.com/12531298/101312107-ef4f6980-3820-11eb-86c9-f8a35627dc9b.png )
2 years ago
Bogdan Drutu
4550252565
Remove support to allow_different_nesting, from markdownlint ( #1248 )
...
* Remove support to allow_different_nesting, from markdownlint
Signed-off-by: Bogdan Drutu <bogdandrutu@gmail.com>
* Update specification/metrics/semantic_conventions/README.md
Co-authored-by: Armin Ruech <armin.ruech@dynatrace.com>
* Run markdown-toc
Signed-off-by: Bogdan Drutu <bogdandrutu@gmail.com>
Co-authored-by: Armin Ruech <armin.ruech@dynatrace.com>
2 years ago
Tigran Najaryan
98898e48b5
Change default OTLP port number ( #1221 )
...
* Change default OTLP port number
Contributes to https://github.com/open-telemetry/opentelemetry-specification/issues/1148
Note that a separate port is used for OTLP/HTTP for now. There is currently work
in progress to confirm that we can use the same port. Once we have the confirmation
I will update the spec again to use one port.
* Address PR comments
2 years ago
Tigran Najaryan
8a6da3a7ae
Fix the unclear SHOULD requirement for "gzip" OTLP content type ( #1038 )
...
MUST is the correct requirement here. There is no situation when a different content type is a better choice.
2 years ago
Tigran Najaryan
114910ae58
Use hex encoding for trace id and span id fields in OTLP JSON encoding ( #911 )
...
Resolves: https://github.com/open-telemetry/opentelemetry-specification/issues/786
See discussion and motivation for the change in the issue linked above.
Co-authored-by: Sergey Kanzhelev <S.Kanzhelev@live.com>
2 years ago
alrex
c56fc2dc0e
Allow specifying a single configuration ( #820 )
...
* Allow specifying a single configuration
The following change describes that the OTLP exporter must support configuration for all signals via a single set of configuration options. There is also an example for configuring different signals with different endpoints via environment variables.
* adding a third example
* moving otlp exporter into protocol directory
* add link to exporter from readme
* apply review feedback
2 years ago
Tigran Najaryan
9b025dc4ee
Add link to OTLP specification from README ( #816 )
2 years ago
Tigran Najaryan
3a7162aaa5
Add OTLP to the specification ( #794 )
...
* Add OTLP to the specification
We previously had OTLP definition scattered in multiple OTEPs.
This amalgamates the OTEPs and brings OTLP to the specification repo.
* Address PR comments
* Address PR comments
2 years ago
Bogdan Drutu
02d0878407
Move specifications into sub-directories per signal ( #546 )
...
Signed-off-by: Bogdan Drutu <bogdandrutu@gmail.com>
2 years ago
Tigran Najaryan
c8b5678143
Define OTLP 1.0 Stability guarantees ( #432 )
...
Resolves https://github.com/open-telemetry/opentelemetry-proto/issues/400
2 years ago
Tigran Najaryan
395c8422fe
Clarify how additive changes are handled ( #455 )
...
This PR explicitly lists the additive changes allowed and adds
a requirement that such additive changes must be accompanied by
interoperability explanation when necessary.
This is a subset of https://github.com/open-telemetry/opentelemetry-proto/pull/432
that contains other guarantees that we did not yet agree to.
I believe this particular subset is necessary regardless of
what we decide about #432 .
2 years ago
Craig Andrews
7aa439cb0b
change the collector trace endpoint to /v1/traces ( #449 )
...
Co-authored-by: Reiley Yang <reyang@microsoft.com>
Co-authored-by: Armin Ruech <armin.ruech@dynatrace.com>
2 years ago
Bogdan Drutu
4b23e936e1
Remove optional part from zero_threshold ( #453 )
2 years ago
jack-berg
ff6581489e
Update breaking-change to check against last published version ( #454 )
...
* Update breaking-change to check against last published version
* Fetch tags
2 years ago
Armin Ruech
ce4475566d
Update auto assignment to reflect current TC ( #450 )
2 years ago
Tigran Najaryan
e6dfd7f4ce
Declare OTLP/JSON Stable ( #436 )
2 years ago
Tigran Najaryan
2bdeb79c76
Clarify behavior for empty/not present/invalid trace_id and span_id fields ( #442 )
...
Resolves https://github.com/open-telemetry/opentelemetry-specification/issues/3040
This is not a breaking change:
- For Span it now defines more precisely the receiver behavior that was
previously defined vaguely (e.g. it was unclear what "empty" means for
bytes field).
- For LogRecord it now defines the receiver behavior that was previously
unspecified. This ensures that the wording are consistent with what we
have for the Span.
2 years ago
Ruslan Kovalov
ad7b716783
Introduce an optional `zero_threshold` field to `ExponentialHistogramDataPoint` ( #441 )
2 years ago
Tigran Najaryan
2119dc9aff
Delete requirement to generate new trace/span id if an invalid id is received ( #444 )
...
This is considered an bug in the spec that was uncovered in the discussion here:
https://github.com/open-telemetry/opentelemetry-proto/pull/442#discussion_r1061995668
I did some spelunking and the "generate" recommendation comes from the very first commit:
b5bcfffce0 (diff-ef5f80fbf835dd57e14cb9264944f03d80cf6b04cc7671b0e7fb33167c67efcc)
where they were copied from Java repo, to which they were copied from OpenCensus
https://github.com/open-telemetry/opentelemetry-java/pull/134 and in OpenCensus the
wording first time appeared here https://github.com/census-instrumentation/opencensus-proto/pull/160
(authored by @SergeyKanzhelev , merged by @bogdandrutu ).
We are deleting the requirement to generate a new trace id or span id if an invalid
id is received. The receivers can decide how they want to treat the invalid id (just
like upon receiving any other invalid id), e.g. they may drop it, log an error, accept
the invalid data, etc. We are not going to prescribe a particular receiver behavior
when invalid trace/span id is received.
2 years ago
Tigran Najaryan
d8729d40f6
Prepare for declaring OTLP/JSON Stable ( #435 )
...
This adds guarantees that are necessary for OTLP/JSON wire representation
stability.
This does not yet declare OTLP/JSON. It will be a separate PR once we are
certain nothing else is needed.
2 years ago
Joshua MacDonald
724e427879
Change the exponential histogram boundary condition ( #409 )
2 years ago
Georg Pirklbauer
001e5eabf3
fix a tiny typo and reflow ( #421 )
2 years ago