Skip to content

Commit 1830ef2

Browse files
Liudmila Molkovamaryliag
andauthored
Convert headings to sentence case (#2056)
Co-authored-by: Marylia Gutierrez <[email protected]>
1 parent 6814d83 commit 1830ef2

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+203
-202
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ requirements and recommendations.
1212
<!-- toc -->
1313

1414
- [Sign the CLA](#sign-the-cla)
15-
- [How to Contribute](#how-to-contribute)
15+
- [How to contribute](#how-to-contribute)
1616
- [Which semantic conventions belong in this repo](#which-semantic-conventions-belong-in-this-repo)
1717
- [Suggesting conventions for a new area](#suggesting-conventions-for-a-new-area)
1818
- [Prerequisites](#prerequisites)
@@ -24,12 +24,12 @@ requirements and recommendations.
2424
- [3. Check new convention](#3-check-new-convention)
2525
- [4. Verify the changes before committing](#4-verify-the-changes-before-committing)
2626
- [5. Changelog](#5-changelog)
27-
- [When to add a Changelog Entry](#when-to-add-a-changelog-entry)
27+
- [When to add a changelog entry](#when-to-add-a-changelog-entry)
2828
- [Examples](#examples)
29-
- [Adding a Changelog Entry](#adding-a-changelog-entry)
29+
- [Adding a changelog entry](#adding-a-changelog-entry)
3030
- [5. Getting your PR merged](#5-getting-your-pr-merged)
3131
- [Automation](#automation)
32-
- [Consistency Checks](#consistency-checks)
32+
- [Consistency checks](#consistency-checks)
3333
- [Auto formatting](#auto-formatting)
3434
- [Markdown style](#markdown-style)
3535
- [Misspell check](#misspell-check)
@@ -46,7 +46,7 @@ requirements and recommendations.
4646
Before you can contribute, you will need to sign the [Contributor License
4747
Agreement](https://identity.linuxfoundation.org/projects/cncf).
4848

49-
## How to Contribute
49+
## How to contribute
5050

5151
When contributing to semantic conventions, it's important to understand a few
5252
key, but non-obvious, aspects:
@@ -248,7 +248,7 @@ Refer to the [Automation](#automation) section for more details.
248248

249249
### 5. Changelog
250250

251-
#### When to add a Changelog Entry
251+
#### When to add a changelog entry
252252

253253
Pull requests that contain user-facing changes will require a changelog entry.
254254
Keep in mind the following types of users (not limited to):
@@ -275,7 +275,7 @@ No changelog entry:
275275
- Refactorings with no meaningful change in functionality
276276
- Chores, such as enabling linters, updating dependencies
277277

278-
#### Adding a Changelog Entry
278+
#### Adding a changelog entry
279279

280280
The [CHANGELOG.md](./CHANGELOG.md) files in this repo is autogenerated
281281
from `.yaml` files in the [/.chloggen](/.chloggen) directory.
@@ -319,7 +319,7 @@ to merge**.
319319

320320
Semantic Conventions provides a set of automated tools for general development.
321321

322-
### Consistency Checks
322+
### Consistency checks
323323

324324
The Specification has a number of tools it uses to check things like style,
325325
spelling and link validity.

docs/cloud-providers/aws-sdk.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,11 @@ are found.
1313

1414
Some descriptions are also provided for populating general OpenTelemetry semantic conventions based on these APIs.
1515

16-
## Context Propagation
16+
## Context propagation
1717

1818
See [compatibility](../non-normative/compatibility/aws.md#context-propagation).
1919

20-
## Common Attributes
20+
## Common attributes
2121

2222
The span name MUST be of the format `Service.Operation` as per the AWS HTTP API, e.g., `DynamoDB.GetItem`,
2323
`S3.ListBuckets`. This is equivalent to concatenating `rpc.service` and `rpc.method` with `.` and consistent

docs/database/database-metrics.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ linkTitle: Metrics
1111
- [Database operation](#database-operation)
1212
- [Metric: `db.client.operation.duration`](#metric-dbclientoperationduration)
1313
- [Development](#development)
14-
- [Database Response](#database-response)
14+
- [Database response](#database-response)
1515
- [Metric: `db.client.response.returned_rows`](#metric-dbclientresponsereturned_rows)
1616
- [Connection pools](#connection-pools)
1717
- [Metric: `db.client.connection.count`](#metric-dbclientconnectioncount)
@@ -228,7 +228,7 @@ Even though parameterized query text can potentially have sensitive data, by usi
228228

229229
**Status**: [Development][DocumentStatus]
230230

231-
### Database Response
231+
### Database response
232232

233233
The following metric instruments describe database query response.
234234

docs/database/database-spans.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ linkTitle: Spans
1414
- [Notes and well-known identifiers for `db.system.name`](#notes-and-well-known-identifiers-for-dbsystemname)
1515
- [Sanitization of `db.query.text`](#sanitization-of-dbquerytext)
1616
- [Generating a summary of the query text](#generating-a-summary-of-the-query-text)
17-
- [Semantic Conventions for specific database technologies](#semantic-conventions-for-specific-database-technologies)
17+
- [Semantic conventions for specific database technologies](#semantic-conventions-for-specific-database-technologies)
1818

1919
<!-- tocstop -->
2020

@@ -400,7 +400,7 @@ Semantic conventions for individual database systems or specialized instrumentat
400400
MAY specify a different `db.query.summary` format as long as produced summary remains
401401
relatively short and its cardinality remains low comparing to the `db.query.text`.
402402

403-
## Semantic Conventions for specific database technologies
403+
## Semantic conventions for specific database technologies
404404

405405
More specific Semantic Conventions are defined for the following database technologies:
406406

docs/exceptions/exceptions-logs.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,13 @@ emitted through the [Logger API](https://github.com/open-telemetry/opentelemetry
1212

1313
<!-- toc -->
1414

15-
- [Recording an Exception](#recording-an-exception)
15+
- [Recording an exception](#recording-an-exception)
1616
- [Attributes](#attributes)
17-
- [Stacktrace Representation](#stacktrace-representation)
17+
- [Stacktrace representation](#stacktrace-representation)
1818

1919
<!-- tocstop -->
2020

21-
## Recording an Exception
21+
## Recording an exception
2222

2323
Exceptions SHOULD be recorded as attributes on the
2424
[LogRecord](https://github.com/open-telemetry/opentelemetry-specification/tree/v1.43.0/specification/logs/data-model.md#log-and-event-record-definition) passed to the [Logger](https://github.com/open-telemetry/opentelemetry-specification/tree/v1.43.0/specification/logs/api.md#logger) emit
@@ -57,7 +57,7 @@ The table below indicates which attributes should be added to the
5757
<!-- END AUTOGENERATED TEXT -->
5858
<!-- endsemconv -->
5959

60-
### Stacktrace Representation
60+
### Stacktrace representation
6161

6262
Same as [Trace Semantic Conventions for Exceptions - Stacktrace
6363
Representation](exceptions-spans.md#stacktrace-representation).

docs/exceptions/exceptions-spans.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ exceptions associated with spans.
1212
<!-- toc -->
1313

1414
- [Exception event](#exception-event)
15-
- [Stacktrace Representation](#stacktrace-representation)
15+
- [Stacktrace representation](#stacktrace-representation)
1616

1717
<!-- tocstop -->
1818

@@ -47,7 +47,7 @@ This event describes a single exception.
4747
<!-- END AUTOGENERATED TEXT -->
4848
<!-- endsemconv -->
4949

50-
### Stacktrace Representation
50+
### Stacktrace representation
5151

5252
The table below, adapted from [Google Cloud][gcp-error-reporting], includes
5353
possible representations of stacktraces in various languages. The table is not

docs/faas/aws-lambda.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,13 @@ use cases.
1212
<!-- toc -->
1313

1414
- [All triggers](#all-triggers)
15-
- [AWS X-Ray Active Tracing Considerations](#aws-x-ray-active-tracing-considerations)
16-
- [`xray-lambda` Propagator Functionality](#xray-lambda-propagator-functionality)
15+
- [AWS X-Ray active tracing considerations](#aws-x-ray-active-tracing-considerations)
16+
- [`xray-lambda` propagator functionality](#xray-lambda-propagator-functionality)
1717
- [`xray-lambda` Propagator Configuration](#xray-lambda-propagator-configuration)
1818
- [API Gateway](#api-gateway)
1919
- [SQS](#sqs)
20-
- [SQS Event](#sqs-event)
21-
- [SQS Message](#sqs-message)
20+
- [SQS event](#sqs-event)
21+
- [SQS message](#sqs-message)
2222
- [Examples](#examples)
2323
- [API Gateway Request Proxy (Lambda tracing passive)](#api-gateway-request-proxy-lambda-tracing-passive)
2424
- [API Gateway Request Proxy (Lambda tracing active)](#api-gateway-request-proxy-lambda-tracing-active)
@@ -64,7 +64,7 @@ and the [cloud resource conventions][cloud]. The following AWS Lambda-specific a
6464
[faasres]: /docs/resource/faas.md (FaaS resource conventions)
6565
[cloud]: /docs/resource/cloud.md (Cloud resource conventions)
6666

67-
### AWS X-Ray Active Tracing Considerations
67+
### AWS X-Ray active tracing considerations
6868

6969
When [AWS X-Ray Active Tracing](https://docs.aws.amazon.com/lambda/latest/dg/services-xray.html) is enabled for a Lambda,
7070
the runtime will automatically generate a span based on configured sampling rates and propagate the span context
@@ -74,7 +74,7 @@ This span context is encoded using the [X-Ray Tracing Header Format](https://doc
7474
Users MUST be able to [configure the propagator](#xray-lambda-propagator-configuration) to prioritize propagating this X-Ray "Active Tracing" span context.
7575
(FYI: Users probably want this enabled if OpenTelemetry is configured to report spans to AWS X-Ray so their trace is linked together properly.)
7676

77-
#### `xray-lambda` Propagator Functionality
77+
#### `xray-lambda` propagator functionality
7878

7979
SDK's that have instrumentation for AWS Lambda SHOULD provide an additional propagator alongside the X-Ray propagator
8080
that can [be configured](#xray-lambda-propagator-configuration) via the `OTEL_PROPAGATORS` environment variable setting as `xray-lambda`.
@@ -153,7 +153,7 @@ for creating message processing spans within user code.
153153

154154
The span kind for both types of SQS spans SHOULD be `CONSUMER`.
155155

156-
### SQS Event
156+
### SQS event
157157

158158
For the SQS event span, if all the messages in the event have the same event source, the name of the span MUST
159159
be `<event source> process`. If there are multiple sources in the batch, the name MUST be
@@ -169,7 +169,7 @@ See [compatibility](../non-normative/compatibility/aws.md#context-propagation) f
169169
- [`messaging.operation.type`](/docs/messaging/messaging-spans.md) MUST be set to `process`.
170170
- [`messaging.system`](/docs/messaging/messaging-spans.md) MUST be set to `aws_sqs`.
171171

172-
### SQS Message
172+
### SQS message
173173

174174
For the SQS message span, the name MUST be `<event source> process`. The parent MUST be the `CONSUMER` span
175175
corresponding to the SQS event. The [message system attributes][] (not message attributes, which are provided by

docs/faas/faas-metrics.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ operations. By adding FaaS attributes to metric events it allows for finely tune
1515

1616
<!-- toc -->
1717

18-
- [Metric Instruments](#metric-instruments)
19-
- [FaaS Instance](#faas-instance)
18+
- [Metric instruments](#metric-instruments)
19+
- [FaaS instance](#faas-instance)
2020
- [Metric: `faas.invoke_duration`](#metric-faasinvoke_duration)
2121
- [Metric: `faas.init_duration`](#metric-faasinit_duration)
2222
- [Metric: `faas.coldstarts`](#metric-faascoldstarts)
@@ -27,15 +27,15 @@ operations. By adding FaaS attributes to metric events it allows for finely tune
2727
- [Metric: `faas.cpu_usage`](#metric-faascpu_usage)
2828
- [Metric: `faas.net_io`](#metric-faasnet_io)
2929
- [References](#references)
30-
- [Metric References](#metric-references)
30+
- [Metric references](#metric-references)
3131

3232
<!-- tocstop -->
3333

34-
## Metric Instruments
34+
## Metric instruments
3535

3636
The following metric instruments describe FaaS operations.
3737

38-
### FaaS Instance
38+
### FaaS instance
3939

4040
The following metrics are recorded by the FaaS instance.
4141

@@ -377,7 +377,7 @@ This metric is [recommended][MetricRecommended].
377377

378378
## References
379379

380-
### Metric References
380+
### Metric references
381381

382382
Below are links to documentation regarding metrics that are available with different
383383
FaaS providers. This list is not exhaustive.

docs/faas/faas-spans.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,14 @@ See also the [additional instructions for instrumenting AWS Lambda](aws-lambda.m
1313

1414
<!-- toc -->
1515

16-
- [General Attributes](#general-attributes)
17-
- [Function Name](#function-name)
16+
- [General attributes](#general-attributes)
17+
- [Function name](#function-name)
1818
- [Difference between invocation and instance](#difference-between-invocation-and-instance)
19-
- [Incoming Invocations](#incoming-invocations)
20-
- [Incoming FaaS Span attributes](#incoming-faas-span-attributes)
19+
- [Incoming invocations](#incoming-invocations)
20+
- [Incoming FaaS span attributes](#incoming-faas-span-attributes)
2121
- [Resource attributes as incoming FaaS span attributes](#resource-attributes-as-incoming-faas-span-attributes)
22-
- [Outgoing Invocations](#outgoing-invocations)
23-
- [Function Trigger Type](#function-trigger-type)
22+
- [Outgoing invocations](#outgoing-invocations)
23+
- [Function trigger type](#function-trigger-type)
2424
- [Datasource](#datasource)
2525
- [HTTP](#http)
2626
- [PubSub](#pubsub)
@@ -30,7 +30,7 @@ See also the [additional instructions for instrumenting AWS Lambda](aws-lambda.m
3030

3131
<!-- tocstop -->
3232

33-
## General Attributes
33+
## General attributes
3434

3535
Span `name` should be set to the function name being executed. Depending on the value of the `faas.trigger` attribute, additional attributes MUST be set. For example, an `http` trigger SHOULD follow the [HTTP Server semantic conventions](/docs/http/http-spans.md#http-server-semantic-conventions). For more information, refer to the [Function Trigger Type](#function-trigger-type) section.
3636

@@ -96,7 +96,7 @@ call to invoke the lambda, which is often HTTP).
9696
<!-- END AUTOGENERATED TEXT -->
9797
<!-- endsemconv -->
9898

99-
### Function Name
99+
### Function name
100100

101101
There are 2 locations where the function's name can be recorded: the span name and the
102102
[`faas.name` Resource attribute](../resource/faas.md).
@@ -123,13 +123,13 @@ The span attribute `faas.invocation_id` differs from the [resource attribute][Fa
123123
[Azure functions]: https://docs.microsoft.com/azure/azure-functions/manage-connections#static-clients
124124
[Google functions]: https://cloud.google.com/functions/docs/concepts/execution-environment#scope
125125

126-
## Incoming Invocations
126+
## Incoming invocations
127127

128128
This section describes incoming FaaS invocations as they are reported by the FaaS instance itself.
129129

130130
For incoming FaaS spans, the span kind SHOULD be `SERVER`.
131131

132-
### Incoming FaaS Span attributes
132+
### Incoming FaaS span attributes
133133

134134
<!-- semconv span.faas.server -->
135135
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
@@ -182,7 +182,7 @@ The `cloud.resource_id` and `cloud.account.id` attributes on AWS are some exampl
182182
In principle, the above considerations apply to any resource attribute that fulfills the criteria above
183183
(not being readily available without some extra effort that could be expensive).
184184

185-
## Outgoing Invocations
185+
## Outgoing invocations
186186

187187
This section describes outgoing FaaS invocations as they are reported by a client calling a FaaS instance.
188188

@@ -233,7 +233,7 @@ which the invoked FaaS instance reports about itself, if it's instrumented.
233233
[FaaS resource attributes]: ../resource/faas.md
234234
[Cloud resource attributes]: ../resource/cloud.md
235235

236-
## Function Trigger Type
236+
## Function trigger type
237237

238238
This section describes how to handle the span creation and additional attributes based on the value of the attribute `faas.trigger`.
239239

docs/feature-flags/feature-flags-logs.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,12 @@ This can be used to determine the impact a feature has on a request, enabling en
2424

2525
<!-- toc -->
2626

27-
- [Recording an Evaluation](#recording-an-evaluation)
27+
- [Recording an evaluation](#recording-an-evaluation)
2828
- [Evaluation event](#evaluation-event)
2929

3030
<!-- tocstop -->
3131

32-
## Recording an Evaluation
32+
## Recording an evaluation
3333

3434
Feature flag evaluations SHOULD be recorded as attributes on the
3535
[LogRecord](https://github.com/open-telemetry/opentelemetry-specification/tree/v1.43.0/specification/logs/data-model.md#log-and-event-record-definition) passed to the [Logger](https://github.com/open-telemetry/opentelemetry-specification/tree/v1.43.0/specification/logs/api.md#logger) emit

0 commit comments

Comments
 (0)