Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

adding instrumentation configuration #91

Merged
merged 13 commits into from
Jun 17, 2024
Merged

adding instrumentation configuration #91

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
188d2c6
adding instrumentation configuration
brettmc May 20, 2024
13e4b16
organise general instrumentation config by semconv
brettmc May 21, 2024
eedeed4
update peer service mapping example
brettmc May 22, 2024
26ff699
Apply suggestions from code review
brettmc May 22, 2024
92b40a6
adding comments, sections for all languages
brettmc May 23, 2024
e56291f
expand logback example config, comments
brettmc May 23, 2024
3848fd6
Merge branch 'main' into add-instrumentation
brettmc May 25, 2024
b1a4e80
Add all surface area, docs to kitchen-sink.yaml, use consistent case …
jack-berg May 30, 2024
42a3278
Merge branch 'main' into add-instrumentation
jack-berg May 30, 2024
7a409df
Fix typo
jack-berg May 30, 2024
c27c2aa
Merge branch 'add-instrumentation' of https://github.com/brettmc/open…
jack-berg May 30, 2024
fd8ff2e
Merge branch 'main' into add-instrumentation
jack-berg Jun 4, 2024
69cf873
Merge branch 'main' into add-instrumentation
brettmc Jun 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

## Unreleased

* Adding Instrumentation configuration

## v0.1.0 - 2023-10-05

Initial configuration schema release, including:
Expand Down
39 changes: 39 additions & 0 deletions examples/kitchen-sink.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -426,3 +426,42 @@ resource:
- process.command_args
# Configure the resource schema URL.
schema_url: https://opentelemetry.io/schemas/1.16.0
# Configure instrumentation
brettmc marked this conversation as resolved.
Show resolved Hide resolved
instrumentation:
# General SemConv options that may apply to multiple languages
brettmc marked this conversation as resolved.
Show resolved Hide resolved
general:
peer:
brettmc marked this conversation as resolved.
Show resolved Hide resolved
service-mapping:
jack-berg marked this conversation as resolved.
Show resolved Hide resolved
brettmc marked this conversation as resolved.
Show resolved Hide resolved
- peer: foo
service: bar
- peer: bar
service: bat
http:
brettmc marked this conversation as resolved.
Show resolved Hide resolved
client:
brettmc marked this conversation as resolved.
Show resolved Hide resolved
request:
capture-headers:
- X-Foo
response:
capture-headers:
- X-Foo
server:
request:
capture-headers:
- X-Bar
response:
capture-headers:
- X-Bar
db:
statement-sanitizer:
jack-berg marked this conversation as resolved.
Show resolved Hide resolved
enabled: true
# Language-specific module options
java:
logback-appender:
jack-berg marked this conversation as resolved.
Show resolved Hide resolved
experimental:
capture-mdc-attributes:
- attr_one
- attr_two
php:
example_instrumentation:
span_name: test123
enabled: true
114 changes: 114 additions & 0 deletions schema/instrumentation.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,114 @@
{
"$id": "https://opentelemetry.io/otelconfig/instrumentation.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Instrumentation",
"type": "object",
"additionalProperties": false,
"properties": {
"general": {
"type": "object",
"additionalProperties": false,
"properties": {
"peer": {
jack-berg marked this conversation as resolved.
Show resolved Hide resolved
"type": "object",
"properties": {
"service-mapping": {
"type": "array",
"items": {
"$ref": "#/$defs/PeerServiceMapping"
}
}
}
},
"http": {
"type": "object",
"additionalProperties": false,
"properties": {
"client": {
"$ref": "#/$defs/RequestResponseCaptureHeaders"
},
"server": {
"$ref": "#/$defs/RequestResponseCaptureHeaders"
}
}
},
"db": {
"type": "object",
"additionalProperties": false,
"properties": {
"statement-sanitizer": {
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
}
}
}
}
}
}
},
"java": {
"$ref": "#/$defs/JavaModules"
},
"js": {
"$ref": "#/$defs/JsModules"
},
"php": {
"$ref": "#/$defs/PhpModules"
},
"python": {
"$ref": "#/$defs/PythonModules"
}
},
"$defs": {
"PeerServiceMapping": {
"type": "object",
"additionalProperties": false,
"properties": {
"peer": {
"type": "string"
},
"service": {
"type": "string"
}
},
"required": [
"peer",
"service"
]
},
"ArrayOfHeaders": {
"type": "array",
"items": {
"type": "string"
}
},
"CaptureHeaders": {
"type": "object",
"additionalProperties": false,
"properties": {
"capture-headers": {
"$ref": "#/$defs/ArrayOfHeaders"
}
}
},
"RequestResponseCaptureHeaders": {
"type": "object",
"additionalProperties": false,
"properties": {
"request": {
"$ref": "#/$defs/CaptureHeaders"
},
"response": {
"$ref": "#/$defs/CaptureHeaders"
}
}
},
"JavaModules": {},
brettmc marked this conversation as resolved.
Show resolved Hide resolved
"JsModules": {},
"PhpModules": {},
"PythonModules": {}
}
}
3 changes: 3 additions & 0 deletions schema/opentelemetry_configuration.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,9 @@
},
"resource": {
"$ref": "resource.json"
},
"instrumentation": {
"$ref": "instrumentation.json"
}
},
"required": [
Expand Down
Loading