Skip to content

Commit f37118d

Browse files
chalintiffany76opentelemetrybot
authored
Glossary: add terms from style guide, and some rework (#6074)
Co-authored-by: Tiffany Hrabusa <[email protected]> Co-authored-by: opentelemetrybot <[email protected]>
1 parent 163b434 commit f37118d

File tree

7 files changed

+172
-110
lines changed

7 files changed

+172
-110
lines changed

content/en/docs/collector/management.md

+10-11
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ the collector. These topics are covered elsewhere:
1313

1414
- [Quick Start](/docs/collector/quick-start/) to understand how to install the
1515
OpenTelemetry Collector.
16-
- [Configuration][otel-collector-configuration] for how to configure the
17-
OpenTelemetry Collector, setting up telemetry pipelines.
16+
- [Configuration] for how to configure the OpenTelemetry Collector, setting up
17+
telemetry pipelines.
1818

1919
## Basics
2020

@@ -24,8 +24,7 @@ Typical agent management tasks include:
2424
1. Querying the agent information and configuration. The agent information can
2525
include its version, operating system related information, or capabilities.
2626
The configuration of the agent refers to its telemetry collection setup, for
27-
example, the OpenTelemetry Collector
28-
[configuration][otel-collector-configuration].
27+
example, the OpenTelemetry Collector [configuration].
2928
1. Upgrading/downgrading agents and management of agent-specific packages,
3029
including the base agent functionality and plugins.
3130
1. Applying new configurations to agents. This might be required because of
@@ -44,12 +43,12 @@ ideally done using OpenTelemetry.
4443

4544
Observability vendors and cloud providers offer proprietary solutions for agent
4645
management. In the open source observability space, there is an emerging
47-
standard that you can use for agent management: Open Agent Management Protocol
46+
standard that you can use for agent management: [Open Agent Management Protocol]
4847
(OpAMP).
4948

50-
The [OpAMP specification][opamp-spec] defines how to manage a fleet of telemetry
51-
data agents. These agents can be [OpenTelemetry collectors][otel-collector],
52-
Fluent Bit or other agents in any arbitrary combination.
49+
The [OpAMP specification] defines how to manage a fleet of telemetry data
50+
agents. These agents can be [OpenTelemetry Collectors](/docs/collector/), Fluent
51+
Bit or other agents in any arbitrary combination.
5352

5453
> **Note** The term "agent" is used here as a catch-all term for OpenTelemetry
5554
> components that respond to OpAMP, this could be the collector but also SDK
@@ -216,9 +215,9 @@ otelcol_receiver_refused_metric_points{receiver="prometheus/own_metrics",service
216215
Protocol][opamp-lt]
217216
- [What is OpAMP & What is BindPlane][opamp-bindplane]
218217

219-
[otel-collector]: /docs/collector/
220-
[otel-collector-configuration]: /docs/collector/configuration/
221-
[opamp-spec]:
218+
[configuration]: /docs/collector/configuration/
219+
[Open Agent Management Protocol]: https://github.com/open-telemetry/opamp-spec/
220+
[OpAMP specification]:
222221
https://github.com/open-telemetry/opamp-spec/blob/main/specification.md
223222
[opamp-in-otel-collector]:
224223
https://docs.google.com/document/d/1KtH5atZQUs9Achbce6LiOaJxLbksNJenvgvyKLsJrkc/edit#heading=h.ioikt02qpy5f

0 commit comments

Comments
 (0)