Skip to content

Commit 41069af

Browse files
authored
Merge pull request #10159 from circleci/otel-usage-attributes
Document the com.circleci.resource.usage.* OTel attributes
2 parents 4918d2b + fb2fd75 commit 41069af

1 file changed

Lines changed: 43 additions & 0 deletions

File tree

docs/guides/modules/integration/pages/open-telemetry-integration.adoc

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -490,6 +490,49 @@ resource class.
490490

491491
|`com.circleci.resource.ram` |4096 |The amount of RAM allocated in MB.
492492

493+
|`com.circleci.resource.usage.cpu.mean` |0.42 |Mean CPU usage for the task. The
494+
values are in the range `0.0` to `1.0` with the latter meaning 100% usage
495+
across all cores. Only present for `build` jobs when usage data is available.
496+
497+
|`com.circleci.resource.usage.cpu.min` |0.01 |The lowest CPU usage observed
498+
during the task. The values are in the range `0.0` to `1.0` with the latter
499+
meaning 100% usage across all cores. Only present for `build` jobs when usage
500+
data is available.
501+
502+
|`com.circleci.resource.usage.cpu.max` |0.98 |The highest CPU usage observed
503+
during the task. The values are in the range `0.0` to `1.0` with the latter
504+
meaning 100% usage across all cores. Only present for `build` jobs when usage
505+
data is available.
506+
507+
|`com.circleci.resource.usage.cpu.p90` |0.98 |The 90th percentile of the CPU
508+
usage observed during the task. The values are in the range `0.0` to `1.0` with
509+
the latter meaning 100% usage across all cores. Only present for `build` jobs
510+
when usage data is available.
511+
512+
|`com.circleci.resource.usage.memory.mean` |1073741824 |Mean memory usage
513+
in bytes across the task. Only present for `build` jobs when usage data is
514+
available.
515+
516+
|`com.circleci.resource.usage.memory.min` |536870912 |The lowest memory usage
517+
in bytes observed during the task. Only present for `build` jobs when usage
518+
data is available.
519+
520+
|`com.circleci.resource.usage.memory.max` |2147483648 |The highest memory usage
521+
in bytes observed during the task. Only present for `build` jobs when usage
522+
data is available.
523+
524+
|`com.circleci.resource.usage.memory.p90` |1932735283 |The 90th percentile of
525+
the memory usage in bytes during the task. Only present for `build` jobs when
526+
usage data is available.
527+
528+
|`com.circleci.resource.usage.network.bytes_received` |10485760 |Total bytes
529+
received over the network during the task. Only present for `build` jobs when
530+
usage data is available and the value is greater than zero.
531+
532+
|`com.circleci.resource.usage.network.bytes_sent` |5242880 |Total bytes sent
533+
over the network during the task. Only present for `build` jobs when usage
534+
data is available and the value is greater than zero.
535+
493536
|`com.circleci.task.index` |0 |The zero-based index of this task within
494537
its parallel job.
495538

0 commit comments

Comments
 (0)