[editorial] Use sentence case for doc page titles (#1839)

This commit is contained in:
Patrice Chalin 2025-01-28 10:21:28 -05:00 committed by GitHub
parent 5b24784e03
commit aff2c09add
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
120 changed files with 129 additions and 121 deletions

View File

@ -1,5 +1,4 @@
<!--- Hugo front matter used to generate the website version of this page:
linkTitle: Semantic Conventions
cascade:
body_class: otel-docs-spec
github_repo: &repo https://github.com/open-telemetry/semantic-conventions
@ -8,12 +7,13 @@ cascade:
github_project_repo: *repo
cSpell:ignore: semconv CICD
auto_gen: below
linkTitle: Semantic conventions
path_base_for_github_subdir:
from: tmp/semconv/docs/_index.md
to: README.md
--->
# OpenTelemetry Semantic Conventions
# OpenTelemetry semantic conventions
The Semantic Conventions define a common set of (semantic) attributes which provide meaning to data when collecting, producing and consuming it.
The Semantic Conventions specify among other things span names and kind, metric instruments and units as well as attribute names, types, meaning and valid values. For a detailed definition of the Semantic Conventions' scope see [Semantic Conventions Stability](https://opentelemetry.io/docs/specs/otel/versioning-and-stability/#semantic-conventions-stability).

View File

@ -10,7 +10,7 @@ path_base_for_github_subdir:
<!-- NOTE: THIS FILE IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
<!-- see templates/registry/markdown/readme.md.j2 -->
# Attribute Registry
# Attribute registry
The attributes registry is the place where attributes are defined. An attribute definition covers the following properties of an attribute:

View File

@ -1,7 +1,7 @@
<!-- NOTE: THIS FILE IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
<!-- see templates/registry/markdown/attribute_namespace.md.j2 -->
# Feature Flag
# Feature flag
## Feature Flag Attributes

View File

@ -1,7 +1,7 @@
<!-- NOTE: THIS FILE IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
<!-- see templates/registry/markdown/attribute_namespace.md.j2 -->
# Security Rule
# Security rule
## Security Rule

View File

@ -1,7 +1,7 @@
<!-- NOTE: THIS FILE IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
<!-- see templates/registry/markdown/attribute_namespace.md.j2 -->
# User Agent
# User agent
## User-agent Attributes

View File

@ -5,7 +5,7 @@ path_base_for_github_subdir:
to: azure/README.md
--->
# Semantic Conventions for Azure Resource Logs
# Semantic conventions for Azure resource logs
**Status**: [Experimental][DocumentStatus]

View File

@ -2,7 +2,7 @@
linkTitle: Events
--->
# Semantic Conventions for Azure Resource Log Events
# Semantic conventions for Azure resource log events
**Status**: [Experimental][DocumentStatus]

View File

@ -2,7 +2,7 @@
linkTitle: CICD
--->
# Semantic Conventions for CICD Metrics
# Semantic conventions for CICD metrics
**Status**: [Experimental][DocumentStatus]

View File

@ -2,7 +2,7 @@
linkTitle: CLI programs
--->
# Semantic Conventions for CLI (Command Line Interface) Programs
# Semantic conventions for CLI (command line interface) programs
**Status**: [Experimental][DocumentStatus]

View File

@ -5,7 +5,7 @@ path_base_for_github_subdir:
to: cloud-providers/README.md
--->
# Semantic Conventions for Cloud Providers
# Semantic conventions for cloud providers
**Status**: [Experimental][DocumentStatus]

View File

@ -2,7 +2,7 @@
linkTitle: AWS SDK
--->
# Semantic Conventions for AWS SDK
# Semantic conventions for AWS SDK
**Status**: [Experimental][DocumentStatus]

View File

@ -5,7 +5,7 @@ path_base_for_github_subdir:
to: cloudevents/README.md
--->
# Semantic Conventions for CloudEvents
# Semantic conventions for CloudEvents
**Status**: [Experimental][DocumentStatus]

View File

@ -2,7 +2,7 @@
linkTitle: CloudEvents spans
--->
# Semantic Conventions for CloudEvents Spans
# Semantic conventions for CloudEvents spans
**Status**: [Experimental][DocumentStatus]

View File

@ -5,7 +5,7 @@ path_base_for_github_subdir:
to: code/README.md
--->
# Semantic Conventions for Code
# Semantic conventions for code
**Status**: [Experimental][DocumentStatus]

View File

@ -5,7 +5,7 @@ path_base_for_github_subdir:
to: database/README.md
--->
# Semantic Conventions for Database Calls and Systems
# Semantic conventions for database calls and systems
**Status**: [Mixed][DocumentStatus]

View File

@ -2,7 +2,7 @@
linkTitle: Cassandra
--->
# Semantic Conventions for Cassandra
# Semantic conventions for Cassandra
**Status**: [Experimental][DocumentStatus]

View File

@ -2,7 +2,7 @@
linkTitle: Cosmos DB
--->
# Semantic Conventions for Microsoft Azure Cosmos DB
# Semantic conventions for Microsoft Azure Cosmos DB
**Status**: [Experimental][DocumentStatus]

View File

@ -2,7 +2,7 @@
linkTitle: CouchDB
--->
# Semantic Conventions for CouchDB
# Semantic conventions for CouchDB
**Status**: [Experimental][DocumentStatus]

View File

@ -2,7 +2,7 @@
linkTitle: Metrics
--->
# Semantic Conventions for Database Client Metrics
# Semantic conventions for database client metrics
**Status**: [Mixed][DocumentStatus]

View File

@ -2,7 +2,7 @@
linkTitle: Spans
--->
# Semantic Conventions for Database Client Spans
# Semantic conventions for database client spans
**Status**: [Release Candidate][DocumentStatus], unless otherwise specified

View File

@ -2,7 +2,7 @@
linkTitle: AWS DynamoDB
--->
# Semantic Conventions for AWS DynamoDB
# Semantic conventions for AWS DynamoDB
**Status**: [Experimental][DocumentStatus]

View File

@ -2,7 +2,7 @@
linkTitle: Elasticsearch
--->
# Semantic Conventions for Elasticsearch
# Semantic conventions for Elasticsearch
**Status**: [Experimental][DocumentStatus]

View File

@ -2,7 +2,7 @@
linkTitle: HBase
--->
# Semantic Conventions for HBase
# Semantic conventions for HBase
**Status**: [Experimental][DocumentStatus]

View File

@ -2,7 +2,7 @@
linkTitle: MariaDB
--->
# Semantic Conventions for MariaDB
# Semantic conventions for MariaDB
**Status**: [Release Candidate][DocumentStatus]

View File

@ -2,7 +2,7 @@
linkTitle: MongoDB
--->
# Semantic Conventions for MongoDB
# Semantic conventions for MongoDB
**Status**: [Experimental][DocumentStatus]

View File

@ -2,7 +2,7 @@
linkTitle: MSSQL
--->
# Semantic Conventions for MSSQL
# Semantic conventions for MSSQL
**Status**: [Release Candidate][DocumentStatus]

View File

@ -2,7 +2,7 @@
linkTitle: MySQL
--->
# Semantic Conventions for MySQL
# Semantic conventions for MySQL
**Status**: [Release Candidate][DocumentStatus]

View File

@ -2,7 +2,7 @@
linkTitle: PostgreSQL
--->
# Semantic Conventions for PostgreSQL
# Semantic conventions for PostgreSQL
**Status**: [Release Candidate][DocumentStatus]

View File

@ -2,7 +2,7 @@
linkTitle: Redis
--->
# Semantic Conventions for Redis
# Semantic conventions for Redis
**Status**: [Experimental][DocumentStatus]

View File

@ -2,7 +2,7 @@
linkTitle: SQL
--->
# Semantic Conventions for SQL Databases
# Semantic conventions for SQL databases
**Status**: [Release Candidate][DocumentStatus]

View File

@ -2,7 +2,7 @@
linkTitle: DNS
--->
# Semantic Conventions for DNS Queries
# Semantic conventions for DNS queries
**Status**: [Experimental][DocumentStatus]

View File

@ -5,7 +5,7 @@ path_base_for_github_subdir:
to: dotnet/README.md
--->
# Semantic Conventions for .NET Metrics
# Semantic conventions for .NET metrics
**Status**: [Stable][DocumentStatus]

View File

@ -2,7 +2,7 @@
linkTitle: ASP.NET Core
--->
# Semantic Conventions for ASP.NET Core Metrics
# Semantic conventions for ASP.NET Core metrics
**Status**: [Stable][DocumentStatus]

View File

@ -2,7 +2,7 @@
linkTitle: DNS
--->
# Semantic Conventions for DNS Metrics Emitted by .NET
# Semantic conventions for DNS metrics emitted by .NET
**Status**: [Stable][DocumentStatus]

View File

@ -2,7 +2,7 @@
linkTitle: HTTP
--->
# Semantic Conventions for HTTP Client and Server Metrics Emitted by .NET
# Semantic conventions for HTTP client and server metrics emitted by .NET
**Status**: [Stable][DocumentStatus]

View File

@ -2,7 +2,7 @@
linkTitle: Kestrel
--->
# Semantic Conventions for Kestrel Web Server Metrics
# Semantic conventions for Kestrel web server metrics
**Status**: [Stable][DocumentStatus]

View File

@ -2,7 +2,7 @@
linkTitle: SignalR
--->
# Semantic Conventions for SignalR Server Metrics
# Semantic conventions for SignalR server metrics
**Status**: [Stable][DocumentStatus]

View File

@ -5,7 +5,7 @@ path_base_for_github_subdir:
to: exceptions/README.md
--->
# Semantic Conventions for Exceptions
# Semantic conventions for exceptions
**Status**: [Stable][DocumentStatus]

View File

@ -2,7 +2,7 @@
linkTitle: Logs
--->
# Semantic Conventions for Exceptions in Logs
# Semantic conventions for exceptions in logs
**Status**: [Stable][DocumentStatus]

View File

@ -2,7 +2,7 @@
linkTitle: Spans
--->
# Semantic Conventions for Exceptions on Spans
# Semantic conventions for exceptions on spans
**Status**: [Stable][DocumentStatus]

View File

@ -5,7 +5,7 @@ path_base_for_github_subdir:
to: faas/README.md
--->
# Semantic Conventions for Function-as-a-Service
# Semantic conventions for Function-as-a-Service
**Status**: [Experimental][DocumentStatus]

View File

@ -2,7 +2,7 @@
linkTitle: Metrics
--->
# Semantic Conventions for FaaS Metrics
# Semantic conventions for FaaS metrics
**Status**: [Experimental][DocumentStatus]

View File

@ -2,7 +2,7 @@
linkTitle: Spans
--->
# Semantic Conventions for FaaS Spans
# Semantic conventions for FaaS spans
**Status**: [Experimental][DocumentStatus]

View File

@ -5,7 +5,7 @@ path_base_for_github_subdir:
to: feature-flags/README.md
--->
# Semantic Conventions for Feature Flags
# Semantic conventions for feature flags
**Status**: [Experimental][DocumentStatus]

View File

@ -2,7 +2,7 @@
linkTitle: Logs
--->
# Semantic Conventions for Feature Flags in Logs
# Semantic conventions for feature flags in logs
**Status**: [Experimental][DocumentStatus]

View File

@ -5,7 +5,7 @@ path_base_for_github_subdir:
to: gen-ai/README.md
--->
# Semantic Conventions for Generative AI Systems
# Semantic conventions for generative AI systems
**Status**: [Experimental][DocumentStatus]

View File

@ -2,7 +2,7 @@
linkTitle: Azure AI Inference
--->
# Semantic Conventions for Azure AI Inference
# Semantic conventions for Azure AI Inference
**Status**: [Experimental][DocumentStatus]

View File

@ -2,7 +2,7 @@
linkTitle: Events
--->
# Semantic Conventions for Generative AI Events
# Semantic conventions for generative AI events
**Status**: [Experimental][DocumentStatus]

View File

@ -2,7 +2,7 @@
linkTitle: Metrics
--->
# Semantic Conventions for Generative AI Metrics
# Semantic conventions for generative AI metrics
**Status**: [Experimental][DocumentStatus]

View File

@ -2,7 +2,7 @@
linkTitle: Spans
--->
# Semantic Conventions for Generative AI Spans
# Semantic conventions for generative AI spans
**Status**: [Experimental][DocumentStatus]

View File

@ -2,7 +2,7 @@
linkTitle: OpenAI
--->
# Semantic Conventions for OpenAI Operations
# Semantic conventions for OpenAI operations
**Status**: [Experimental][DocumentStatus]

View File

@ -7,7 +7,7 @@ path_base_for_github_subdir:
to: general/README.md
--->
# General Semantic Conventions
# General semantic conventions
This document defines general Semantic Conventions for spans, metrics, logs and events.

View File

@ -1,4 +1,4 @@
# Attribute Requirement Levels
# Attribute requirement levels
**Status**: [Stable][DocumentStatus]

View File

@ -3,7 +3,7 @@ linkTitle: Attributes
aliases: [general-attributes]
--->
# General Attributes
# General attributes
**Status**: [Experimental][DocumentStatus]

View File

@ -3,7 +3,7 @@ linkTitle: Events
aliases: [events-general]
--->
# Semantic Conventions for Events
# Semantic conventions for events
**Status**: [Development][DocumentStatus]

View File

@ -3,7 +3,7 @@ linkTitle: Logs
aliases: [logs-general]
--->
# General Logs Attributes
# General logs attributes
**Status**: [Experimental][DocumentStatus]

View File

@ -1,4 +1,4 @@
# Metric Requirement Levels
# Metric requirement levels
**Status**: [Stable][DocumentStatus]

View File

@ -3,7 +3,7 @@ linkTitle: Metrics
aliases: [metrics-general]
--->
# Metrics Semantic Conventions
# Metrics semantic conventions
**Status**: [Mixed][DocumentStatus]

View File

@ -2,7 +2,7 @@
linkTitle: Profiles
--->
# General Profiles Attributes
# General profiles attributes
**Status**: [Experimental][DocumentStatus]

View File

@ -1,4 +1,4 @@
# Recording Errors
# Recording errors
**Status**: [Development][DocumentStatus].

View File

@ -1,9 +1,9 @@
<!--- Hugo front matter used to generate the website version of this page:
linkTitle: Semantic Convention Groups
linkTitle: Semantic convention groups
aliases: [group-stability]
--->
# Semantic Convention Groups
# Semantic convention groups
**Status**: [Experimental][DocumentStatus]

View File

@ -2,7 +2,7 @@
linkTitle: Session
--->
# Semantic Conventions for Session
# Semantic conventions for session
**Status**: [Experimental][DocumentStatus]

View File

@ -2,7 +2,7 @@
linkTitle: Tracing compatibility
--->
# Semantic Conventions for Tracing Compatibility Components
# Semantic conventions for tracing compatibility components
**Status**: [Experimental][DocumentStatus]

View File

@ -3,7 +3,7 @@ linkTitle: Trace
aliases: [trace-general]
--->
# Trace Semantic Conventions
# Trace semantic conventions
**Status**: [Mixed][DocumentStatus]

View File

@ -2,7 +2,7 @@
linkTitle: GraphQL server
--->
# Semantic Conventions for GraphQL Server
# Semantic conventions for GraphQL server
**Status**: [Experimental][DocumentStatus]

View File

@ -5,7 +5,7 @@ path_base_for_github_subdir:
to: hardware/README.md
--->
# Semantic Conventions for Hardware
# Semantic conventions for hardware
**Status**: [Experimental][DocumentStatus]

View File

@ -2,7 +2,7 @@
linkTitle: Common hardware
--->
# Semantic Conventions for Common Hardware Metrics
# Semantic conventions for common hardware metrics
**Status**: [Experimental][DocumentStatus]

View File

@ -5,7 +5,7 @@ path_base_for_github_subdir:
to: http/README.md
--->
# Semantic Conventions for HTTP
# Semantic conventions for HTTP
**Status**: [Mixed][DocumentStatus]

View File

@ -2,7 +2,7 @@
linkTitle: Metrics
--->
# Semantic Conventions for HTTP Metrics
# Semantic conventions for HTTP metrics
**Status**: [Mixed][DocumentStatus]

View File

@ -2,7 +2,7 @@
linkTitle: Spans
--->
# Semantic Conventions for HTTP Spans
# Semantic conventions for HTTP spans
**Status**: [Stable][DocumentStatus], Unless otherwise specified.

View File

@ -5,7 +5,7 @@ path_base_for_github_subdir:
to: messaging/README.md
--->
# Semantic Conventions for Messaging Systems
# Semantic conventions for messaging systems
**Status**: [Experimental][DocumentStatus]

View File

@ -2,7 +2,7 @@
linkTitle: Azure
--->
# Semantic Conventions for Azure Messaging Systems
# Semantic conventions for Azure messaging systems
**Status**: [Experimental][DocumentStatus]

View File

@ -2,7 +2,7 @@
linkTitle: Google Cloud Pub/Sub
--->
# Semantic Conventions for Google Cloud Pub/Sub
# Semantic conventions for Google Cloud Pub/Sub
**Status**: [Experimental][DocumentStatus]

View File

@ -2,7 +2,7 @@
linkTitle: Kafka
--->
# Semantic Conventions for Kafka
# Semantic conventions for Kafka
**Status**: [Experimental][DocumentStatus]

View File

@ -2,7 +2,7 @@
linkTitle: Metrics
--->
# Semantic Conventions for Messaging Client Metrics
# Semantic conventions for messaging client metrics
**Status**: [Experimental][DocumentStatus]

View File

@ -2,7 +2,7 @@
linkTitle: Spans
--->
# Semantic Conventions for Messaging Spans
# Semantic conventions for messaging spans
**Status**: [Experimental][DocumentStatus]

View File

@ -2,7 +2,7 @@
linkTitle: RabbitMQ
--->
# Semantic Conventions for RabbitMQ
# Semantic conventions for RabbitMQ
**Status**: [Experimental][DocumentStatus]

View File

@ -2,7 +2,7 @@
linkTitle: RocketMQ
--->
# Semantic Conventions for RocketMQ
# Semantic conventions for RocketMQ
**Status**: [Experimental][DocumentStatus]

View File

@ -5,7 +5,7 @@ path_base_for_github_subdir:
to: mobile/README.md
--->
# Semantic Conventions for Mobile Platform
# Semantic conventions for mobile platform
**Status**: [Experimental][DocumentStatus]

View File

@ -2,7 +2,7 @@
linkTitle: Events
--->
# Semantic Conventions for Mobile Events
# Semantic conventions for mobile events
**Status**: [Experimental][DocumentStatus]

View File

@ -5,7 +5,7 @@ path_base_for_github_subdir:
to: non-normative/README.md
--->
# Non-Normative Supplementary Information
# Non-normative supplementary information
The pages in this section are **non-normative**, most are supplementary
guidelines.

View File

@ -1,4 +1,4 @@
# Generating Semantic Convention Libraries
# Generating semantic convention libraries
<!-- toc -->

View File

@ -2,7 +2,7 @@
linkTitle: AWS
--->
# Compatibility Considerations for AWS
# Compatibility considerations for AWS
This page highlights compatibility considerations for OpenTelemetry
instrumentations when interacting with AWS managed services using an aws-sdk,

View File

@ -2,7 +2,7 @@
linkTitle: Database migration
--->
# Database Semantic Convention Stability Migration Guide
# Database semantic convention stability migration guide
> [!WARNING]
> This document is a work in progress and the database semantic conventions

View File

@ -1,4 +1,4 @@
# System Semantic Conventions: Instrumentation Design Philosophy
# System semantic conventions: instrumentation design philosophy
The System Semantic Conventions are caught in a strange dichotomy that is unique
among other semconv groups. While we want to make sure we cover obvious generic

View File

@ -2,7 +2,7 @@
linkTitle: System use cases
--->
# System Semantic Conventions: General Use Cases
# System semantic conventions: general use cases
This document is a collection of the use cases that we want to cover with the
System Semantic Conventions. The use cases outlined here inform the working

View File

@ -3,7 +3,7 @@ linkTitle: HTTP migration
aliases: [../http/migration-guide]
--->
# HTTP Semantic Convention Stability Migration
# HTTP semantic convention stability migration
Due to the significant number of modifications and the extensive user base
affected by them, existing HTTP instrumentations published by

View File

@ -2,7 +2,7 @@
linkTitle: K8s migration
--->
# K8s Semantic Convention Stability Migration
# K8s semantic convention stability migration
Due to the significant number of modifications and the extensive user base
affected by them, existing K8s instrumentations published by

View File

@ -5,7 +5,7 @@ path_base_for_github_subdir:
to: object-stores/README.md
--->
# Semantic Conventions for Object Stores
# Semantic conventions for object stores
**Status**: [Experimental, Feature-freeze][DocumentStatus]

View File

@ -2,7 +2,7 @@
linkTitle: AWS S3
--->
# Semantic Conventions for AWS S3
# Semantic conventions for AWS S3
**Status**: [Experimental][DocumentStatus]

View File

@ -5,7 +5,7 @@ path_base_for_github_subdir:
to: resource/README.md
--->
# Resource Semantic Conventions
# Resource semantic conventions
**Status**: [Mixed][DocumentStatus]

View File

@ -4,7 +4,7 @@ path_base_for_github_subdir:
to: resource/cloud-provider/README.md
--->
# Cloud Provider
# Cloud provider
**Status**: [Experimental][DocumentStatus]

View File

@ -5,7 +5,7 @@ path_base_for_github_subdir:
to: resource/cloud-provider/aws/README.md
--->
# AWS Semantic Conventions
# AWS semantic conventions
**Status**: [Experimental][DocumentStatus]

View File

@ -1,4 +1,4 @@
# AWS Logs
# AWS logs
<!-- semconv resource.aws.log -->
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->

View File

@ -5,7 +5,7 @@ path_base_for_github_subdir:
to: resource/cloud-provider/gcp/README.md
--->
# GCP Semantic Conventions
# GCP semantic conventions
**Status**: [Experimental][DocumentStatus]

View File

@ -1,4 +1,4 @@
# Operating System
# Operating system
In case of virtualized environments, this is the operating system as it is observed by the process, i.e., the virtualized guest rather than the underlying host.

View File

@ -2,7 +2,7 @@
linkTitle: Process
--->
# Process and Process Runtime Resources
# Process and process runtime resources
**Status**: [Experimental][DocumentStatus]

View File

@ -5,7 +5,7 @@ path_base_for_github_subdir:
to: rpc/README.md
--->
# Semantic Conventions for RPC
# Semantic conventions for RPC
**Status**: [Experimental][DocumentStatus]

View File

@ -2,7 +2,7 @@
linkTitle: Connect
--->
# Semantic Conventions for Connect RPC
# Semantic conventions for Connect RPC
**Status**: [Experimental][DocumentStatus]

View File

@ -2,7 +2,7 @@
linkTitle: gRPC
--->
# Semantic Conventions for gRPC
# Semantic conventions for gRPC
**Status**: [Experimental][DocumentStatus]

Some files were not shown because too many files have changed in this diff Show More