Skip to content
This repository was archived by the owner on Sep 4, 2025. It is now read-only.

Commit 5273e0b

Browse files
authored
Updating telemetry documentation for new helper framework (#59)
Updating telemetry docs for new framework
1 parent 774c01d commit 5273e0b

File tree

3 files changed

+22
-17
lines changed

3 files changed

+22
-17
lines changed

website/docs/cloud-docs/agents/logging.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,9 +76,9 @@ internal URLs, and other sensitive material.
7676
Flash Messages are a type of log that HashiCorp may send to agents from time to time. These messages may be used to communicate important or breaking changes to the agent. Flash Messages will be emitted when HashiCorp adds a new one, or when starting up an agent for the first time. Their output looks something like:
7777

7878
```
79-
2021-09-22T15:20:59.269Z [WARN] core.notice: A breaking change is incoming.
79+
2021-09-22T15:20:59.269Z [WARN] notice: A breaking change is incoming.
8080
```
8181

8282
Flash Messages are version specific, and may only apply to the specific version of the agent you are running.
8383

84-
Adding monitoring and alerting for these `core.notice` messages may help you operate Terraform Cloud Agents more easily.
84+
Adding monitoring and alerting for these `notice` messages may help you operate Terraform Cloud Agents more easily.

website/docs/cloud-docs/agents/metrics.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Terraform Cloud agents emit three types of metric data:
3838

3939
The following metrics are generated by the Terraform Cloud Agent core program,
4040
and are related to generic operations performed regularly by all agents. All
41-
metrics in this section are prefixed by `tfc-agent.`.
41+
metrics in this section are prefixed by `tfc-agent.core.`.
4242

4343
| Meric name | Type | Description |
4444
| ---------------------------- | ----- | -------------------------------------------------------------------- |
@@ -59,7 +59,7 @@ processes (such as the Terraform binary or other programs) which maintain their
5959
own distinct runtimes and consume resources independently of the agent. To
6060
monitor resource utilization comprehensively, consider monitoring VM or
6161
container metrics. All metrics in this section are prefixed by
62-
`tfc-agent.runtime.`.
62+
`tfc-agent.core.runtime.`.
6363

6464
| Metric name | Type | Description |
6565
| ------------------------------- | ----- | --------------------------------------------------- |
@@ -81,7 +81,7 @@ container metrics. All metrics in this section are prefixed by
8181

8282
The following metrics are emitted by the `terraform` component, which is
8383
responsible for handling Terraform operations like plans and applies. All
84-
metrics in this section are prefixed by `tfc-agent.terraform.`.
84+
metrics in this section are prefixed by `tfc-agent.core.terraform.`.
8585

8686
| Metric name | Type | Description |
8787
| ---------------------------------------------- | ----- | ----------------------------------------------------------------------------------- |
@@ -136,7 +136,7 @@ metrics in this section are prefixed by `tfc-agent.terraform.`.
136136

137137
The following metrics are emitted by the `policy` component, which is
138138
responsible for handling OPA policy enforcement operations. All metrics in this
139-
section are prefixed by `tfc-agent.policy.`.
139+
section are prefixed by `tfc-agent.core.policy.`.
140140

141141
| Metric name | Type | Description |
142142
| ---------------------------------------------- | ----- | -------------------------------------------------------- |

website/docs/cloud-docs/agents/tracing.mdx

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,21 @@ description: >-
88

99
The agent emits tracing spans that can be consumed by various distributed
1010
tracing tools. Information about supported tools can be found on the
11-
[OpenTelemetry Registry](https://opentelemetry.io/registry/). A span is a
12-
single unit of work performed by the agent.
11+
[OpenTelemetry Registry](https://opentelemetry.io/registry/). A span describes
12+
a single, concise unit of work performed by the agent, such as writing a file
13+
or downloading an artifact.
1314

14-
Spans conform to the following rules:
15+
## Span names
1516

16-
* Each span has a unique name in plain English, explaining what it represents.
17-
Due to this descriptive nature of spans, individual trace spans are not
18-
documented on this page.
19-
* Span attributes will be made up of sections, separated by periods. Sections
20-
will contain only alphanumeric characters and underscores.
21-
For example: `run.terraform_version`.
22-
* Span attributes in the `debug` namespace will have information relevant to
23-
the current span's scope.
17+
Each span has a unique name in plain English, explaining what it represents.
18+
Due to this descriptive nature of spans, individual trace spans are not
19+
documented on this page.
20+
21+
## Span attributes
22+
23+
Span attribute keys typically contain only letters, numbers, and underscores.
24+
In some cases, span attributes may contain dots (`.`) to provide structure to a
25+
set of related attributes.
26+
27+
Span attributes in the `debug` namespace will have information relevant to the
28+
current span's scope.

0 commit comments

Comments
 (0)