Skip to content
78 changes: 39 additions & 39 deletions receiver/apachereceiver/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ metrics:

The number of connections in different asynchronous states reported by Apache's server-status.

| Unit | Metric Type | Value Type |
| ---- | ----------- | ---------- |
| {connections} | Gauge | Int |
| Unit | Metric Type | Value Type | Stability |
| ---- | ----------- | ---------- | --------- |
| {connections} | Gauge | Int | development |

#### Attributes

Expand All @@ -30,17 +30,17 @@ The number of connections in different asynchronous states reported by Apache's

Current load of the CPU.

| Unit | Metric Type | Value Type |
| ---- | ----------- | ---------- |
| % | Gauge | Double |
| Unit | Metric Type | Value Type | Stability |
| ---- | ----------- | ---------- | --------- |
| % | Gauge | Double | development |

### apache.cpu.time

Jiffs used by processes of given category.

| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
| ---- | ----------- | ---------- | ----------------------- | --------- |
| {jiff} | Sum | Double | Cumulative | true |
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
| {jiff} | Sum | Double | Cumulative | true | development |

#### Attributes

Expand All @@ -53,59 +53,59 @@ Jiffs used by processes of given category.

The number of active connections currently attached to the HTTP server.

| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
| ---- | ----------- | ---------- | ----------------------- | --------- |
| {connections} | Sum | Int | Cumulative | false |
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
| {connections} | Sum | Int | Cumulative | false | development |

### apache.load.1

The average server load during the last minute.

| Unit | Metric Type | Value Type |
| ---- | ----------- | ---------- |
| % | Gauge | Double |
| Unit | Metric Type | Value Type | Stability |
| ---- | ----------- | ---------- | --------- |
| % | Gauge | Double | development |

### apache.load.15

The average server load during the last 15 minutes.

| Unit | Metric Type | Value Type |
| ---- | ----------- | ---------- |
| % | Gauge | Double |
| Unit | Metric Type | Value Type | Stability |
| ---- | ----------- | ---------- | --------- |
| % | Gauge | Double | development |

### apache.load.5

The average server load during the last 5 minutes.

| Unit | Metric Type | Value Type |
| ---- | ----------- | ---------- |
| % | Gauge | Double |
| Unit | Metric Type | Value Type | Stability |
| ---- | ----------- | ---------- | --------- |
| % | Gauge | Double | development |

### apache.request.time

Total time spent on handling requests.

| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
| ---- | ----------- | ---------- | ----------------------- | --------- |
| ms | Sum | Int | Cumulative | true |
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
| ms | Sum | Int | Cumulative | true | development |

### apache.requests

The number of requests serviced by the HTTP server per second.

| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
| ---- | ----------- | ---------- | ----------------------- | --------- |
| {requests} | Sum | Int | Cumulative | true |
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
| {requests} | Sum | Int | Cumulative | true | development |

### apache.scoreboard

The number of workers in each state.

The [apache scoreboard](https://metacpan.org/pod/Apache::Scoreboard#DESCRIPTION) is an encoded representation of the state of all the server's workers. This metric decodes the scoreboard and presents a count of workers in each state.

| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
| ---- | ----------- | ---------- | ----------------------- | --------- |
| {workers} | Sum | Int | Cumulative | false |
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
| {workers} | Sum | Int | Cumulative | false | development |

#### Attributes

Expand All @@ -117,25 +117,25 @@ The [apache scoreboard](https://metacpan.org/pod/Apache::Scoreboard#DESCRIPTION)

Total HTTP server traffic.

| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
| ---- | ----------- | ---------- | ----------------------- | --------- |
| By | Sum | Int | Cumulative | true |
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
| By | Sum | Int | Cumulative | true | development |

### apache.uptime

The amount of time that the server has been running in seconds.

| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
| ---- | ----------- | ---------- | ----------------------- | --------- |
| s | Sum | Int | Cumulative | true |
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
| s | Sum | Int | Cumulative | true | development |

### apache.workers

The number of workers currently attached to the HTTP server.

| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
| ---- | ----------- | ---------- | ----------------------- | --------- |
| {workers} | Sum | Int | Cumulative | false |
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
| {workers} | Sum | Int | Cumulative | false | development |

#### Attributes

Expand Down
26 changes: 26 additions & 0 deletions receiver/apachereceiver/metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,8 @@ attributes:
metrics:
apache.uptime:
enabled: true
stability:
level: development
description: The amount of time that the server has been running in seconds.
unit: s
sum:
Expand All @@ -79,6 +81,8 @@ metrics:
attributes: []
apache.current_connections:
enabled: true
stability:
level: development
description: The number of active connections currently attached to the HTTP server.
unit: "{connections}"
sum:
Expand All @@ -89,6 +93,8 @@ metrics:
attributes: []
apache.workers:
enabled: true
stability:
level: development
description: The number of workers currently attached to the HTTP server.
unit: "{workers}"
sum:
Expand All @@ -99,6 +105,8 @@ metrics:
attributes: [workers_state]
apache.requests:
enabled: true
stability:
level: development
description: The number of requests serviced by the HTTP server per second.
unit: "{requests}"
sum:
Expand All @@ -109,6 +117,8 @@ metrics:
attributes: []
apache.traffic:
enabled: true
stability:
level: development
description: Total HTTP server traffic.
unit: By
sum:
Expand All @@ -118,6 +128,8 @@ metrics:
attributes: []
apache.cpu.time:
enabled: true
stability:
level: development
description: Jiffs used by processes of given category.
unit: "{jiff}"
sum:
Expand All @@ -128,6 +140,8 @@ metrics:
attributes: [cpu_level, cpu_mode]
apache.cpu.load:
enabled: true
stability:
level: development
description: Current load of the CPU.
unit: "%"
gauge:
Expand All @@ -136,6 +150,8 @@ metrics:
attributes: []
apache.load.1:
enabled: true
stability:
level: development
description: The average server load during the last minute.
unit: "%"
gauge:
Expand All @@ -144,6 +160,8 @@ metrics:
attributes: []
apache.load.5:
enabled: true
stability:
level: development
description: The average server load during the last 5 minutes.
unit: "%"
gauge:
Expand All @@ -152,6 +170,8 @@ metrics:
attributes: []
apache.load.15:
enabled: true
stability:
level: development
description: The average server load during the last 15 minutes.
unit: "%"
gauge:
Expand All @@ -160,6 +180,8 @@ metrics:
attributes: []
apache.request.time:
enabled: true
stability:
level: development
description: Total time spent on handling requests.
unit: ms
sum:
Expand All @@ -170,6 +192,8 @@ metrics:
attributes: []
apache.scoreboard:
enabled: true
stability:
level: development
description: The number of workers in each state.
extended_documentation: >-
The [apache scoreboard](https://metacpan.org/pod/Apache::Scoreboard#DESCRIPTION)
Expand All @@ -183,6 +207,8 @@ metrics:
attributes: [scoreboard_state]
apache.connections.async:
enabled: true
stability:
level: development
description: The number of connections in different asynchronous states reported by Apache's server-status.
unit: "{connections}"
gauge:
Expand Down