Skip to content

Commit 3873dbb

Browse files
committed
Move specifications into sub-directories per signal
Signed-off-by: Bogdan Drutu <[email protected]>
1 parent 0ea77a9 commit 3873dbb

File tree

29 files changed

+84
-84
lines changed

29 files changed

+84
-84
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -14,19 +14,19 @@ The OpenTelemetry specification describes the cross-language requirements and ex
1414
- [Package/Library Layout](specification/library-layout.md)
1515
- [Concurrency and Thread-Safety](specification/concurrency.md)
1616
- API Specification
17-
- [CorrelationContext](specification/api-correlationcontext.md)
18-
- [Propagators](specification/api-propagators.md)
19-
- [Tracing](specification/api-tracing.md)
20-
- [Metrics](specification/api-metrics.md)
21-
- [User-Facing API](specification/api-metrics-user.md)
22-
- [Meter API](specification/api-metrics-meter.md)
17+
- [CorrelationContext](specification/correlationcontext/api.md)
18+
- [Propagators](specification/context/api-propagators.md)
19+
- [Tracing](specification/trace/api.md)
20+
- [Metrics](specification/metrics/api.md)
21+
- [User-Facing API](specification/metrics/api-user.md)
22+
- [Meter API](specification/metrics/api-meter.md)
2323
- SDK Specification
24-
- [Tracing](specification/sdk-tracing.md)
25-
- [Resource](specification/sdk-resource.md)
24+
- [Tracing](specification/trace/sdk.md)
25+
- [Resource](specification/resource/sdk.md)
2626
- [Configuration](specification/sdk-configuration.md)
2727
- Data Specification
28-
- [Semantic Conventions](specification/data-semantic-conventions.md)
29-
- [Protocol](specification/protocol.md)
28+
- [Semantic Conventions](specification/overview.md#semantic-conventions.md)
29+
- [Protocol](specification/protocol/README.md)
3030
- About the Project
3131
- [Timeline](#project-timeline)
3232
- [Notation Conventions and Compliance](#notation-conventions-and-compliance)
File renamed without changes.
File renamed without changes.
File renamed without changes.

milestones.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Parity can be defined as the following features:
2727
- An SDK implementing OpenTelemetry specification.
2828
- Backwards compatibility with OpenTracing and OpenCensus via bridges.
2929
- Metadata helpers or other means for recording common operations defined in the
30-
OpenTelemetry [semantic conventions](specification/data-semantic-conventions.md).
30+
OpenTelemetry [semantic conventions](specification/overview.md#semantic-conventions.md).
3131
- Tests which provide evidence of interoperability.
3232
- Benchmarks which provide evidence of expected resource utilization.
3333
- Documentation and getting started guide.
File renamed without changes.
File renamed without changes.
File renamed without changes.

specification/glossary.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ specification.
88
Denotes the library that implements the *OpenTelemetry API*.
99

1010
See [Library Guidelines](library-guidelines.md#sdk-implementation) and
11-
[Library resource semantic conventions](data-resource-semantic-conventions.md#telemetry-sdk)
11+
[Library resource semantic conventions](resource/semantic_conventions/README.md#telemetry-sdk)
1212

1313
<a name="instrumented_library"></a>
1414

@@ -38,11 +38,11 @@ Synonyms: *Instrumentation Library*, *Integration*.
3838
## Tracer Name / Meter Name
3939

4040
This refers to the `name` and (optional) `version` arguments specified when
41-
creating a new `Tracer` or `Meter` (see [Obtaining a Tracer](api-tracing.md#obtaining-a-tracer)/[Obtaining a Meter](api-metrics-user.md#obtaining-a-meter)). It identifies the [Instrumenting Library](#instrumenting_library).
41+
creating a new `Tracer` or `Meter` (see [Obtaining a Tracer](trace/api.md#obtaining-a-tracer)/[Obtaining a Meter](metrics/api-user.md#obtaining-a-meter)). It identifies the [Instrumenting Library](#instrumenting_library).
4242

4343
## Namespace
4444

45-
This term applies to [Metric names](api-metrics-user.md#metric-names) only. The namespace is used to disambiguate identical metric
45+
This term applies to [Metric names](metrics/api-user.md#metric-names) only. The namespace is used to disambiguate identical metric
4646
names used in different [instrumenting libraries](#instrumenting_library). The [Name](#name) provided
4747
for creating a `Meter` serves as its namespace in addition to the primary semantics
4848
described [here](#name).

specification/library-guidelines.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ _Note to Language Library Authors:_ OpenTelemetry specification, API and SDK imp
3535

3636
Here is a generic design for a language library (arrows indicate calls):
3737

38-
![Language Library Design Diagram](img/library-design.png)
38+
![Language Library Design Diagram](../internal/img/library-design.png)
3939

4040
### Expected Usage
4141

@@ -55,7 +55,7 @@ This self-sufficiency is achieved the following way.
5555

5656
The API dependency contains a minimal implementation of the API. When no other implementation is explicitly included in the application no telemetry data will be collected. Here is what active components look like in this case:
5757

58-
![Minimal Operation Diagram](img/library-minimal.png)
58+
![Minimal Operation Diagram](../internal/img/library-minimal.png)
5959

6060
It is important that values returned from this minimal implementation of API are valid and do not require the caller to perform extra checks (e.g. createSpan() method should not fail and should return a valid non-null Span object). The caller should not need to know and worry about the fact that minimal implementation is in effect. This minimizes the boilerplate and error handling in the instrumented code.
6161

@@ -67,17 +67,17 @@ SDK implementation is a separate (optional) dependency. When it is plugged in it
6767

6868
SDK implements core functionality that is required for translating API calls into telemetry data that is ready for exporting. Here is how OpenTelemetry components look like when SDK is enabled:
6969

70-
![Full Operation Diagram](img/library-full.png)
70+
![Full Operation Diagram](../internal/img/library-full.png)
7171

72-
SDK defines an [Exporter interface](sdk-tracing.md#span-exporter). Protocol-specific exporters that are responsible for sending telemetry data to backends must implement this interface.
72+
SDK defines an [Exporter interface](trace/sdk.md#span-exporter). Protocol-specific exporters that are responsible for sending telemetry data to backends must implement this interface.
7373

7474
SDK also includes optional helper exporters that can be composed for additional functionality if needed.
7575

76-
Library designers need to define the language-specific `Exporter` interface based on [this generic specification](sdk-tracing.md#span-exporter).
76+
Library designers need to define the language-specific `Exporter` interface based on [this generic specification](trace/sdk.md#span-exporter).
7777

7878
#### Protocol Exporters
7979

80-
Telemetry backend vendors are expected to implement [Exporter interface](sdk-tracing.md#span-exporter). Data received via Export() function should be serialized and sent to the backend in a vendor-specific way.
80+
Telemetry backend vendors are expected to implement [Exporter interface](trace/sdk.md#span-exporter). Data received via Export() function should be serialized and sent to the backend in a vendor-specific way.
8181

8282
Vendors are encouraged to keep protocol-specific exporters as simple as possible and achieve desirable additional functionality such as queuing and retrying using helpers provided by SDK.
8383

0 commit comments

Comments
 (0)