DiamondLightSource / DiamondLightSource/mx-bluesky

Decide on what/when to instrument code for OTEL and document this

Open
#1,279 0 comments 0 reactions 0 assignees View on GitHub
enhancement hyperion
Dominant language
Python
Stars
4
Forks
5
Avg merge
1d 30m
Merged PRs (30d)
2

Description

Add some guidelines in the developer guide on what methods to instrument in mx-bluesky / Hyperion and dodal:

At a minimum, suggest
* Significant high level experiment plans / subplans
* Callback events (should check whether bluesky provides any OOTB instrumentation for this
* Interactions with external services (again, need to check how much we get for free)
* Agamemnon instruction fetch/decode
* Nexus file writing

Similarly for dodal:
* Non-trivial device implementations, e.g. arming the eiger
* Instrumentation of ophyd-async may be helpful and reduce the amount we need to instrument directly in dodal
*

## Acceptance Criteria
- Specific criteria that will be used to judge if the issue is fixed

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.