Skip to content

Commit

Permalink
Link to intra-site pages using a local reference (#924)
Browse files Browse the repository at this point in the history
  • Loading branch information
chalin committed Nov 16, 2021
1 parent 28820f0 commit 91b6f56
Show file tree
Hide file tree
Showing 5 changed files with 28 additions and 31 deletions.
41 changes: 19 additions & 22 deletions content/en/docs/concepts/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ others. This page captures terminology used in the project and what it means.
mechanism for propagating name/value pairs to help establish a causal
relationship between events and services.
- **Client Library:** See `Instrumented Library`.
- **[Collector](https://opentelemetry.io/docs/collector/):**
- **[Collector](/docs/collector/):**
A vendor-agnostic implementation on how to receive, process, and export
telemetry data. A single binary that can be deployed as an agent or gateway.
- **Contrib:** Several `Instrumentation Libraries` and the `Collector` offer a set
Expand All @@ -34,35 +34,28 @@ others. This page captures terminology used in the project and what it means.
Allows all `Data Sources` to share an underlying context mechanism for storing
state and accessing data across the lifespan of a `Transaction`.
- **[DAG](https://en.wikipedia.org/wiki/Directed_acyclic_graph):** Directed Acyclic Graph.
- **[Data
Source](https://github.com/open-telemetry/opentelemetry.io/blob/main/content/en/docs/concepts/data-sources.md):** One
of `Traces`, `Metrics` or `Logs`.
- **[Data Source](/docs/concepts/data-sources):** One of `Traces`, `Metrics` or `Logs`.
- **Dimension:** See `Label`.
- **[Distributed
Tracing](https://opentelemetry.io/docs/concepts/data-sources/#traces):**
- **[Distributed Tracing](/docs/concepts/data-sources/#traces):**
Tracks the progression of a single `Request`, called a `Trace`, as it is handled
by `Services` that make up an `Application`. A `Distributed Trace` transverses
process, network and security boundaries.
- **Event:** Something that happened where representation depends on the `Data
Source`. For example,
[`Spans`]({{< relref "/docs/reference/specification/trace/api#add-events" >}}).
- **Exporter:** Provides functionality to emit telemetry to consumers. Used by
[Instrumentation
Libraries]({{< relref "/docs/reference/specification/glossary#exporter-library" >}})
and the
[Collector](https://github.com/open-telemetry/opentelemetry.io/blob/main/content/en/docs/collector/configuration.md#basics).
[Instrumentation Libraries][spec-exporter-lib] and the
[Collector](/docs/collector/configuration#basics).
Exporters can be push or pull based.
- **[Field]({{< relref "/docs/reference/specification/logs/data-model#field-kinds" >}}):**
name/value pairs added to `Log Records` (similar to `Attributes` for `Spans` and
`Labels` for `Metrics`).
- **[gRPC](https://grpc.io):** A high-performance, open source universal `RPC` framework.
- **[HTTP](https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol):** Hypertext Transfer Protocol.
- **[Instrumented
Library]({{< relref "/docs/reference/specification/glossary#instrumented-library" >}}):**
- **[Instrumented Library][spec-instrumented-lib]:**
Denotes the `Library` for which the telemetry signals (`Traces`, `Metrics`, `Logs`)
are gathered.
- **[Instrumentation
Library]({{< relref "/docs/reference/specification/glossary#instrumentation-library" >}}):**
- **[Instrumentation Library][spec-instrumentation-lib]:**
Denotes the `Library` that provides the instrumentation for a given
`Instrumented Library`. `Instrumented Library` and `Instrumentation Library` may be
the same `Library` if it has built-in OpenTelemetry instrumentation.
Expand All @@ -82,7 +75,7 @@ others. This page captures terminology used in the project and what it means.
where it happened, etc.
- **Metadata:** name/value pair added to telemetry data. OpenTelemetry calls
this `Attributes` on `Spans`, `Labels` on `Metrics` and `Fields` on `Logs`.
- **[Metric](https://opentelemetry.io/docs/concepts/data-sources/#metrics):**
- **[Metric](/docs/concepts/data-sources/#metrics):**
Records a data point, either raw measurements or predefined aggregation, as
timeseries with `Metadata`.
- **OC:** `OpenCensus`.
Expand All @@ -98,12 +91,12 @@ others. This page captures terminology used in the project and what it means.
exported. For example, batching. Used by [Instrumentation
Libraries]({{< relref "/docs/reference/specification/trace/sdk#span-processor" >}})
and the
[Collector](https://opentelemetry.io/docs/collector/configuration/#processors).
- **[Propagators](https://opentelemetry.io/docs/go/instrumentation/#propagators-and-context):** Used to
[Collector](/docs/collector/configuration/#processors).
- **[Propagators](/docs/go/instrumentation/#propagators-and-context):** Used to
serialize and deserialize specific parts of telemetry data such as span
context and `Baggage` in `Spans`.
- **[Proto](https://opentelemetry.io/docs/concepts/components/#proto):** Language independent interface types.
- **[Receiver](https://opentelemetry.io/docs/collector/configuration/#receivers):**
- **[Proto](/docs/concepts/components/#proto):** Language independent interface types.
- **[Receiver](/docs/collector/configuration/#receivers):**
Term used by the `Collector` to define how telemetry data is received.
Receivers can be push or pull based.
- **Request:** See `Distributed Tracing`.
Expand All @@ -127,20 +120,20 @@ others. This page captures terminology used in the project and what it means.
`Service` may be deployed in multiple locations.
- **[Span]({{< relref "/docs/reference/specification/trace/api#span" >}}):**
Represents a single operation within a `Trace`.
- **[Specification](https://opentelemetry.io/docs/concepts/components/#specification):**
- **[Specification](/docs/concepts/components/#specification):**
Describes the cross-language requirements and expectations for all
implementations.
- **[Status]({{< relref "/docs/reference/specification/trace/api#set-status" >}}):**
The result of the operation. Typically used to indicate whether an error
occurred.
- **Tag:** See `Metadata`.
- **Tag:** see `Metadata`.
- **[Trace]({{< relref "/docs/reference/specification/overview#traces" >}}):**
A `DAG` of `Spans`, where the edges between `Spans` are defined as
parent/child relationship.
- **[Tracer]({{< relref "/docs/reference/specification/trace/api#tracer" >}}):**
Responsible for creating `Spans`.
- **Transaction:** See `Distributed Tracing`.
- **[zPages](https://github.com/open-telemetry/opentelemetry-specification/blob/main/experimental/trace/zpages.md):**
- **[zPages][]:**
An in-process alternative to external exporters. When included, they collect
and aggregate tracing and metrics information in the background; this data is
served on web pages when requested.
Expand Down Expand Up @@ -170,3 +163,7 @@ others. This page captures terminology used in the project and what it means.
- **[Metric Conventions]({{< relref "/docs/reference/specification/metrics/semantic_conventions" >}})**

[Attribute]: {{< relref "/docs/reference/specification/common/common#attributes" >}}
[spec-exporter-lib]: {{< relref "/docs/reference/specification/glossary#exporter-library" >}}
[spec-instrumentation-lib]: {{< relref "/docs/reference/specification/glossary#instrumentation-library" >}}
[spec-instrumented-lib]: {{< relref "/docs/reference/specification/glossary#instrumented-library" >}}
[zPages]: https://github.com/open-telemetry/opentelemetry-specification/blob/main/experimental/trace/zpages.md
12 changes: 6 additions & 6 deletions content/en/docs/concepts/instrumenting-library.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ If you have any feedback or want to add a new convention - please come and contr

## When **not** to instrument

Some libraries are thin clients wrapping network calls. Chances are that OpenTelemetry has auto-instrumentation for the underlying RPC client (check out the [registry](https://opentelemetry.io/registry/)). In this case, library instrumentation may not be necessary.
Some libraries are thin clients wrapping network calls. Chances are that OpenTelemetry has auto-instrumentation for the underlying RPC client (check out the [registry](/registry/)). In this case, library instrumentation may not be necessary.

Don't instrument if:

Expand Down Expand Up @@ -137,7 +137,7 @@ WARNING: Generic solution to avoid duplication is under construction 🚧.

Traces is one of the signals you may emit. Events (or logs) and traces complement, not duplicate, each other. Whenever you have something that should have a verbosity, logs are a better choice than traces.

Chances are your library uses logs or some similar mechanism already. Check out [OpenTelemetry registry](https://opentelemetry.io/registry/) to see if OpenTelemetry has integration with it. Integrations usually stamps active trace context on all logs, so users can correlate them.
Chances are your library uses logs or some similar mechanism already. Check out [OpenTelemetry registry](/registry/) to see if OpenTelemetry has integration with it. Integrations usually stamps active trace context on all logs, so users can correlate them.

If your language and ecosystem don't have common logging libraries, use span events for additional details you want to share with users. [Events]({{< relref "/docs/reference/specification/trace/api#add-events" >}}) maybe more convenient when you want to add attributes as well.

Expand Down Expand Up @@ -171,9 +171,9 @@ try (Scope unused = span.makeCurrent()) {
}
```

Here're the full [examples of context extraction in Java](https://opentelemetry.io/docs/java/manual_instrumentation/#context-propagation), check out OpenTelemetry documentation in your language.
Here're the full [examples of context extraction in Java](/docs/java/manual_instrumentation/#context-propagation), check out OpenTelemetry documentation in your language.

In the case of a messaging system, you may receive more than one message at once. Received messages become [*links*](https://opentelemetry.io/docs/java/manual_instrumentation/#create-spans-with-links) on the span you create.
In the case of a messaging system, you may receive more than one message at once. Received messages become [*links*](/docs/java/manual_instrumentation/#create-spans-with-links) on the span you create.
Refer to [messaging conventions]({{< relref "/docs/reference/specification/trace/semantic_conventions/messaging" >}}) for details (WARNING: messaging conventions are [under constructions](https://github.com/open-telemetry/oteps/pull/173) 🚧).

### Injecting context
Expand All @@ -200,7 +200,7 @@ try (Scope unused = span.makeCurrent()) {
}
```

Here's the full [example of context injection in Java](https://opentelemetry.io/docs/java/manual_instrumentation/#context-propagation).
Here's the full [example of context injection in Java](/docs/java/manual_instrumentation/#context-propagation).

There might be some exceptions:

Expand Down Expand Up @@ -229,7 +229,7 @@ There might be some exceptions:

### Instrumentation registry

Please add your instrumentation library to the [OpenTelemetry registry](https://opentelemetry.io/registry/), so users can find it.
Please add your instrumentation library to the [OpenTelemetry registry](/registry/), so users can find it.

### Performance

Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/contribution-guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ OpenTelemetry is an open source project, and we gladly accept new contributions

## Contributing to the OpenTelemetry Documentation

Individual SIGs may maintain documentation above and beyond what is offered here, but we strive for accurate general guidance on using the project from our main website, located at <https://github.com/open-telemetry/opentelemetry.io>.
Individual SIGs may maintain documentation above and beyond what is offered here, but we strive for accurate general guidance on using the project from our main website.

The per-language API, SDK, and "Getting Started" documentation is hosted in each language's GitHub repository.
For more information, [see the Mirrored Documentation section](https://github.com/open-telemetry/opentelemetry.io/blob/main/CONTRIBUTING.md#mirrored-documentation) of the website repository's CONTRIBUTING.md file.
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/js/exporters.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,4 +108,4 @@ const meter = new MeterProvider({
## OpenTelemetry Collector

If you are looking for a vendor-agnostic way to receive, process and export your
telemetry data follow the instructions to setup a [OpenTelemetry collector](https://opentelemetry.io/docs/collector/)
telemetry data follow the instructions to setup a [collector](/docs/collector/)
2 changes: 1 addition & 1 deletion content/en/docs/js/getting-started/nodejs.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ You may also want to use the `BatchSpanProcessor` to export spans in batches in

#### Instrumentation Modules

Many common modules such as the `http` standard library module, `express`, and others can be automatically instrumented using autoinstrumentation modules. To find autoinstrumenatation modules, you can look at the [registry](https://opentelemetry.io/registry/?language=js&component=instrumentation#).
Many common modules such as the `http` standard library module, `express`, and others can be automatically instrumented using autoinstrumentation modules. To find autoinstrumenatation modules, you can look at the [registry](/registry/?language=js&component=instrumentation).

You can also install all instrumentations maintained by the OpenTelemetry authors by using the `@opentelemetry/auto-instrumentations-node` module.

Expand Down

0 comments on commit 91b6f56

Please sign in to comment.