build/devenv: observability component#1141
Merged
Merged
Conversation
This was referenced May 29, 2026
makramkd
previously approved these changes
Jun 2, 2026
Comment on lines
+63
to
+68
| newEnvFn = ccv.NewEnvironment | ||
| // Both env constructors return a value that the up/restart commands | ||
| // discard, so adapt them to the error-only fn. | ||
| newEnvFn = func() error { | ||
| _, err := ccv.NewEnvironment() | ||
| return err | ||
| } |
Collaborator
There was a problem hiding this comment.
nit: this PR duplicates some changes from #1140.
Add a Phase-1 observability component that owns the [observability] config key and publishes beholder monitoring plus the pyroscope URL as a phase output; committeeccv and executor now consume it from that output instead of reading off the topology. Scoped to the phased path only -- the monolith, EnvironmentTopology, and the legacy configs are left unchanged, and just env-phased.toml moves the keys.
|
Code coverage report:
|
Contributor
There was a problem hiding this comment.
Pull request overview
This PR tightens phased devenv configuration validation by failing fast on unrecognized top-level config keys, and introduces a new phased-runtime observability component to own cross-cutting beholder/pyroscope configuration that is consumed by committeeccv and executor.
Changes:
- Convert “unclaimed config keys” from a warning to a hard error (with deterministic ordering) and add coverage for the behavior.
- Add a new
observabilityphased component that publishes monitoring + pyroscope settings as Phase 1 outputs. - Move phased observability TOML config under
[observability]and wirecommitteeccv/executorto consume the new output instead of topology fields.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| build/devenv/runtime/environment.go | Fail fast on unclaimed top-level config keys (sorted) instead of warning. |
| build/devenv/runtime/environment_test.go | Add test asserting unclaimed keys produce an error and name the key. |
| build/devenv/environment.go | Ensure the new observability component registers via blank import. |
| build/devenv/env-phased.toml | Relocate pyroscope/monitoring config under [observability] for phased runtime. |
| build/devenv/components/observability/component.go | New Phase 1 component that validates/decodes and publishes observability settings. |
| build/devenv/components/observability/component_test.go | Unit tests for config validation and Phase 1 output publication. |
| build/devenv/components/executor/component.go | Consume observability output for job-spec generation. |
| build/devenv/components/committeeccv/component.go | Consume observability output for verifier job-spec generation. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ccvdeployment "github.com/smartcontractkit/chainlink-ccv/deployment" | ||
| ) | ||
|
|
||
| const configKey = "observability" |
Comment on lines
+148
to
+150
| obs, ok := priorOutputs["observability"].(*observability.Observability) | ||
| if !ok || obs == nil { | ||
| return nil, nil, fmt.Errorf("executor: observability not found in phase outputs") |
Comment on lines
+100
to
+102
| obs, ok := priorOutputs["observability"].(*observability.Observability) | ||
| if !ok || obs == nil { | ||
| return nil, nil, fmt.Errorf("committeeccv: observability not found in phase outputs") |
makramkd
approved these changes
Jun 2, 2026
4 tasks
huangzhen1997
approved these changes
Jun 2, 2026
Contributor
huangzhen1997
left a comment
huangzhen1997
left a comment
There was a problem hiding this comment.
One nit about https://github.com/smartcontractkit/chainlink-ccv/pull/1141/changes#r3343379497, but I think raw string is used in many places, so can be done in the future
Collaborator
Author
Thanks @huangzhen1997, Makram gave some similar feedback. Worth addressing in a followup. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PR Chain
There are multiple open pull requests that feed into each other:
Description
Testing
Checklist
changelogdirectory)just lint fix- no new lint errorsjust generate- mocks and protobufs are up to date