Skip to content

Update telemetry configuration and documentation for external stack usage - #667

Open
HChughtai wants to merge 2 commits into
mainfrom
hrc/telemetry_config
Open

HChughtai wants to merge 2 commits into
mainfrom
hrc/telemetry_config

Conversation

@HChughtai

@HChughtai HChughtai commented Sep 3, 2026

Copy link
Copy Markdown

Description

This pull request updates the system test's OpenTelemetry configuration and documentation to support both a bundled LGTM (Grafana, Loki, Tempo, Mimir) observability stack and an external shared telemetry stack.

Type of change

Please delete options accordingly to the description.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

Suggested Checklist

  • I have performed a self-review of my own code.
  • I have made corresponding changes to the documentation.
  • My changes generate no new warnings.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have passed on my local host device. (see further details at the CONTRIBUTING document)
  • Make sure your branch is up-to-date with main branch. See CONTRIBUTING for a general example to syncronise your branch with the main branch.
  • I have requested review to this PR.
  • I have addressed and marked as resolved all the review comments in my PR.
  • Finally, I have selected squash and merge

@codecov

codecov Bot commented Sep 3, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 85.42%. Comparing base (87f770d) to head (d9e15cb).

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #667      +/-   ##
==========================================
- Coverage   88.38%   85.42%   -2.97%     
==========================================
  Files          81       77       -4     
  Lines        3961     3684     -277     
==========================================
- Hits         3501     3147     -354     
- Misses        460      537      +77     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@HChughtai
HChughtai marked this pull request as ready for review September 4, 2026 12:37
@HChughtai
HChughtai requested a review from p-j-smith September 4, 2026 12:37

@p-j-smith p-j-smith left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

very cool, just a question around whether we should remove the existing lgtm service from the system tests, and how to set up the external stack locally

Comment thread test/README.md
the `telemetry` repo's `otel-agent/` directory, set
`PIXL_NETWORK=system-test_pixl-net` and run:
```bash
docker compose -f docker-compose.yml -f host_overrides/compose.gae14.override.yml up -d

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is host_override/compose.gae1.override.yml something that lives on the GAE, as I don't see it in the repo? Is it possible for me to run the external stack locally and have PIXL system tests send telemetry to it?

Comment thread test/README.md
[http://localhost:3001](http://localhost:3001) and log in with the credentials set
for the `lgtm` service in [`docker-compose.yml`](./docker-compose.yml).

### Using the external telemetry stack instead

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice. Do you think we should remove the lgtm service from the system tests, and only describe how to use the external stack?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants