Skip to content

Commit

Permalink
initial commit of azure logs
Browse files Browse the repository at this point in the history
filled attribute descriptions and examples

add changelog

clean-up yaml to pass linter

add initial description for azure logs markdown

more linter appeasing

rename azure logs md
  • Loading branch information
MikeGoldsmith committed May 14, 2024
1 parent 507daf4 commit 6f8cb8d
Show file tree
Hide file tree
Showing 3 changed files with 121 additions and 0 deletions.
22 changes: 22 additions & 0 deletions .chloggen/add-azure-logs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Use this changelog template to create an entry for release notes.
#
# If your change doesn't affect end users you should instead start
# your pull request title with [chore] or use the "Skip Changelog" label.

# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
change_type: new_component

# The name of the area of concern in the attributes-registry, (e.g. http, cloud, db)
component: azure-logs

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: Add Azure Logs semantic conventions

# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
# The values here must be integers.
issues: [1027]

# (Optional) One or more lines of additional information to render under the primary note.
# These lines will be padded with 2 spaces and then inserted directly into the document.
# Use pipe (|) for multiline entries.
subtext:

Check failure on line 22 in .chloggen/add-azure-logs.yaml

View workflow job for this annotation

GitHub Actions / yamllint

[new-line-at-end-of-file] no new line character at the end of file

Check failure on line 22 in .chloggen/add-azure-logs.yaml

View workflow job for this annotation

GitHub Actions / yamllint

[trailing-spaces] trailing spaces
11 changes: 11 additions & 0 deletions docs/attributes-registry/azure.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!--- Hugo front matter used to generate the website version of this page:
linkTitle: Azure Logs
--->

# Semantic Conventions for Azure Logs

**Status**: [Experimental][DocumentStatus]

This document defines semantic conventions to apply when instrumenting Azure Logs.

[DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/tree/v1.31.0/specification/document-status.md
88 changes: 88 additions & 0 deletions model/registry/azure.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
groups:
- id: registry.azure
prefix: azure
type: attribute_group
brief: >
This document defines generic attributes for Azure Logs.
attributes:
- id: category
type: string
stability: experimental
brief: "The Azure category of the log entry"
examples:
- AuditEvent
- GatewayLogs
- ApplicationGatewayAccessLog
- id: correlation.id
type: string
stability: experimental
brief: "The correlation ID of the log entry"
examples:
- 607964b6-41a5-4e24-a5db-db7aab3b9b34
- id: duration
type: int
stability: experimental
brief: "The duration of the log entry in milliseconds"
examples:
- 1000
- id: identity
type: string
stability: experimental
brief: "The identity of the log entry"
examples:
- "someone"
- id: operation.name
type: string
stability: experimental
brief: "The name of the operation"
examples:
- SecretGet
- Microsoft.ApiManagement/GatewayLogs
- ApplicationGatewayAccess
- id: operation.version
type: string
stability: experimental
brief: "The version of the operation"
examples:
- "1.0"
- id: properties
type: string
stability: experimental
brief: "The properties of the log entry"
examples:
- "{'string': 'value'}"
- "{'int': 1234 }"
- "{'float': '1.234'}"
- "{'bool': true}"
- id: resource.id
type: string
stability: experimental
brief: "The ID of the resource"
examples:
- "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.ApiManagement/service/apim"
- id: result.type
type: string
stability: experimental
brief: "The type of the result"
examples:
- "success"
- "failure"
- id: result.signature
type: string
stability: experimental
brief: "The signature of the result"
examples:
- "00000000-0000-0000-0000-000000000000"
- id: result.description
type: string
stability: experimental
brief: "The description of the result"
examples:
- "The operation was successful"
- "The operation failed"
- id: tenant.id
type: string
stability: experimental
brief: "The ID of the tenant"
examples:
- "00000000-0000-0000-0000-000000000000"

0 comments on commit 6f8cb8d

Please sign in to comment.