Skip to content

doc: update httpd configuration and span attributes #688

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

Open
proost wants to merge 2 commits into
base: main
Choose a base branch
from
+33 −0
Open

doc: update httpd configuration and span attributes #688

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4bb62d9
doc: update httpd configuration and span attributes
proost Sep 13, 2026
10a0365
Merge branch 'main' of github.com:open-telemetry/opentelemetry-cpp-co…
proost Oct 11, 2026
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
33 changes: 33 additions & 0 deletions instrumentation/httpd/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
- Supports exporters: plain file, OTLP
- Supports batch processor
- Supports propagators: [w3c trace-context](https://www.w3.org/TR/trace-context/), [B3](https://github.com/openzipkin/b3-propagation)
- Reports HTTP span attributes (see [Emitted spans](#emitted-spans))

## Requirements

Expand Down Expand Up @@ -85,8 +86,40 @@ __OpenTelemetryIgnoreInbound__
__OpenTelemetrySetAttribute__
Allows to add extra attribute for each span. It takes two text arguments. For example `OpenTelemetrySetAttribute foo bar`

__OpenTelemetrySetResource__
Allows to set a resource attribute for the whole daemon. It takes two text arguments. For example `OpenTelemetrySetResource service.name apache-web-server`

List of configuration options can be found in [provided configuration file](./opentelemetry.conf)

## Emitted spans

One span is created per incoming request. An additional child span is created for
each outgoing `mod_proxy` request.

| | Span kind | Span name |
|---|---|---|
| Incoming request | `Server` | `HTTP <METHOD>` |
| Outgoing `mod_proxy` request | `Client` | `HTTP <METHOD>` |

### Span attributes

Attributes set by the module. Attributes configured with `OpenTelemetrySetAttribute`
are added to every span in addition to these.

| Attribute | Server span | Client span |
|---|---|---|
| `http.server_name` | always | always |
| `http.method` | when set | when set |
| `http.scheme` | when set | - |
| `http.host` | when set | - |
| `http.target` | when set | - |
| `http.url` | - | when set |
| `http.flavor` | HTTP/1.0 and HTTP/1.1 only | - |
| `http.client_ip` | always | always, see below |
| `net.peer.ip` | only when it differs from `http.client_ip` | - |
| `http.status_code` | always | always |
| `http.response_content_length` | always | always |

## Development

### Requirements
Expand Down
Loading