From 9c7e941907931e824dc0f9435eb53f47c2e0df36 Mon Sep 17 00:00:00 2001 From: Nate Rock Date: Fri, 12 Dec 2025 16:49:05 -0600 Subject: [PATCH 1/2] 25.12 updated Maintainer Docs - Telemetry --- resources/telemetry.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/resources/telemetry.md b/resources/telemetry.md index f4408bd21c0..88894afe6ac 100644 --- a/resources/telemetry.md +++ b/resources/telemetry.md @@ -89,14 +89,14 @@ jobs: checks: secrets: inherit needs: telemetry-setup - uses: rapidsai/shared-workflows/.github/workflows/checks.yaml@branch-25.10 + uses: rapidsai/shared-workflows/.github/workflows/checks.yaml@main with: enable_check_generated_files: false ignored_pr_jobs: "telemetry-summarize" ``` {% endraw %} -Syntax for the `ignored_pr_jobs` is [space-separated within the quotes](https://github.com/rapidsai/shared-workflows/blob/branch-25.02/.github/workflows/checks.yaml#L30). +Syntax for the `ignored_pr_jobs` is [space-separated within the quotes](https://github.com/rapidsai/shared-workflows/blob/main/.github/workflows/checks.yaml#L40). * Run the parsing and submission script job as the final job - after `pr-builder`: @@ -119,7 +119,7 @@ Syntax for the `ignored_pr_jobs` is [space-separated within the quotes](https:// * Optionally, add steps to your build scripts to copy additional contents to be bundled with your run results. For example, [cudf uses a special rapids command that shows the sccache - statistics](https://github.com/rapidsai/cudf/blob/branch-25.10/ci/build_cpp.sh#L36) + statistics](https://github.com/rapidsai/cudf/blob/main/ci/build_cpp.sh#L36) and [saves them to a text file in the appropriate location](https://github.com/rapidsai/gha-tools/blob/main/tools/rapids-telemetry-record). * Processing of additional files is automatic, so long as filenames match expected patterns. The currently handled filenames are: @@ -333,17 +333,17 @@ We store our span data using Grafana Tempo. Tempo allows TraceQL queries for fil The query is limited to a certain number of traces and spans per trace, as well as the time range of the query. The maximum time range is 7 days. -The resource-level attributes that are captured can be found in shared-workflows, such as https://github.com/rapidsai/shared-workflows/blob/d94b26cdfafe306cde800e8cc11ed9444a21c634/.github/workflows/conda-cpp-build.yaml#L158. +The resource-level attributes that are captured can be found in shared-workflows, such as https://github.com/rapidsai/shared-workflows/blob/main/.github/workflows/conda-cpp-build.yaml#L168. Additional span attributes get added by [the python script that uses the OpenTelemetry SDK](https://github.com/rapidsai/shared-actions/blob/main/telemetry-impls/summarize/send_trace.py#L317). -From [conda-cpp-build.yaml](https://github.com/rapidsai/shared-workflows/blob/branch-25.04/.github/workflows/conda-cpp-build.yaml#L117): +From [conda-cpp-build.yaml](https://github.com/rapidsai/shared-workflows/blob/main/.github/workflows/conda-cpp-build.yaml#L168): ``` "rapids.PACKAGER=conda,rapids.CUDA_VER=${{ matrix.CUDA_VER }},rapids.PY_VER=${{ matrix.PY_VER }},rapids.ARCH=${{ matrix.ARCH }},rapids.LINUX_VER=${{ matrix.LINUX_VER }}" ``` -From [wheels-test.yaml](https://github.com/rapidsai/shared-workflows/blob/branch-25.04/.github/workflows/wheels-test.yaml#L152) +From [wheels-test.yaml](https://github.com/rapidsai/shared-workflows/blob/branch-25.04/.github/workflows/wheels-test.yaml#L169) ``` "rapids.PACKAGER=wheel,rapids.CUDA_VER=${{ matrix.CUDA_VER }},rapids.PY_VER=${{ matrix.PY_VER }},rapids.ARCH=${{ matrix.ARCH }},rapids.LINUX_VER=${{ matrix.LINUX_VER }},rapids.GPU=${{ matrix.GPU }},rapids.DRIVER=${{ matrix.DRIVER }},rapids.DEPENDENCIES=${{ matrix.DEPENDENCIES }}" ``` From bdb0c844279ae6c4e1d86efb0c6a33e8952b02dc Mon Sep 17 00:00:00 2001 From: Gil Forsyth Date: Thu, 21 May 2026 11:46:32 -0400 Subject: [PATCH 2/2] docs(telemetry): inline a few code examples, permalink the rest --- resources/telemetry.md | 23 ++++++++++++++--------- 1 file changed, 14 insertions(+), 9 deletions(-) diff --git a/resources/telemetry.md b/resources/telemetry.md index 88894afe6ac..f7bc1122194 100644 --- a/resources/telemetry.md +++ b/resources/telemetry.md @@ -96,7 +96,7 @@ jobs: ``` {% endraw %} -Syntax for the `ignored_pr_jobs` is [space-separated within the quotes](https://github.com/rapidsai/shared-workflows/blob/main/.github/workflows/checks.yaml#L40). +Syntax for the `ignored_pr_jobs` is space-separated within the quotes. * Run the parsing and submission script job as the final job - after `pr-builder`: @@ -117,15 +117,20 @@ Syntax for the `ignored_pr_jobs` is [space-separated within the quotes](https:// > NOTE: pay special attention to the `runs-on` entry. This is what dictates that the job runs on a self-hosted runner, which is necessary for network access control. * Optionally, add steps to your build scripts to copy additional contents to be - bundled with your run results. For example, [cudf uses a special rapids - command that shows the sccache - statistics](https://github.com/rapidsai/cudf/blob/main/ci/build_cpp.sh#L36) - and [saves them to a text file in the appropriate location](https://github.com/rapidsai/gha-tools/blob/main/tools/rapids-telemetry-record). + bundled with your run results. For example, cudf uses a [special rapids + command](https://github.com/rapidsai/gha-tools/blob/main/tools/rapids-telemetry-record) that shows the sccache + statistics + and saves them to a text file in the appropriate location: +{% raw %} +``` +rapids-telemetry-record sccache-stats.txt sccache --show-adv-stats +``` +{% endraw %} * Processing of additional files is automatic, so long as filenames match expected patterns. The currently handled filenames are: * sccache-stats.txt -* To add additional filenames/logic to handle, add code to [the Python parsing script](https://github.com/rapidsai/shared-actions/blob/main/telemetry-impls/summarize/send_trace.py#L208) +* To add additional filenames/logic to handle, add code to [the Python parsing script](https://github.com/rapidsai/shared-actions/blob/2c0720ff09faab9b77be88ab9e653360cc37faec/telemetry-impls/summarize/send_trace.py#L208) --- **Below here is docs on how to maintain the backend parts. Project maintainers should not need anything below here.** @@ -335,15 +340,15 @@ The query is limited to a certain number of traces and spans per trace, as well The resource-level attributes that are captured can be found in shared-workflows, such as https://github.com/rapidsai/shared-workflows/blob/main/.github/workflows/conda-cpp-build.yaml#L168. -Additional span attributes get added by [the python script that uses the OpenTelemetry SDK](https://github.com/rapidsai/shared-actions/blob/main/telemetry-impls/summarize/send_trace.py#L317). +Additional span attributes get added by [the python script that uses the OpenTelemetry SDK](https://github.com/rapidsai/shared-actions/blob/2c0720ff09faab9b77be88ab9e653360cc37faec/telemetry-impls/summarize/send_trace.py#L335-L345). -From [conda-cpp-build.yaml](https://github.com/rapidsai/shared-workflows/blob/main/.github/workflows/conda-cpp-build.yaml#L168): +From [conda-cpp-build.yaml](https://github.com/rapidsai/shared-workflows/blob/ece43bbc9347340721e5cc576e6ba69148176d3f/.github/workflows/conda-cpp-build.yaml#L145): ``` "rapids.PACKAGER=conda,rapids.CUDA_VER=${{ matrix.CUDA_VER }},rapids.PY_VER=${{ matrix.PY_VER }},rapids.ARCH=${{ matrix.ARCH }},rapids.LINUX_VER=${{ matrix.LINUX_VER }}" ``` -From [wheels-test.yaml](https://github.com/rapidsai/shared-workflows/blob/branch-25.04/.github/workflows/wheels-test.yaml#L169) +From [wheels-test.yaml](https://github.com/rapidsai/shared-workflows/blob/ece43bbc9347340721e5cc576e6ba69148176d3f/.github/workflows/wheels-test.yaml#L198): ``` "rapids.PACKAGER=wheel,rapids.CUDA_VER=${{ matrix.CUDA_VER }},rapids.PY_VER=${{ matrix.PY_VER }},rapids.ARCH=${{ matrix.ARCH }},rapids.LINUX_VER=${{ matrix.LINUX_VER }},rapids.GPU=${{ matrix.GPU }},rapids.DRIVER=${{ matrix.DRIVER }},rapids.DEPENDENCIES=${{ matrix.DEPENDENCIES }}" ```