Skip to content

Commit

Permalink
add lifecycle to probe readme
Browse files Browse the repository at this point in the history
Signed-off-by: Spencer Schrock <[email protected]>
  • Loading branch information
spencerschrock committed Jun 5, 2024
1 parent 6b5ea83 commit afcefb0
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions probes/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,13 @@ A probe consists of three files:
- `impl.go`: The actual implementation of the probe.
- `impl_test.go`: The probe's test.

## Lifecycle

Probes can exist in several different lifecycle states:
* `Experimental`: The semantics of the probe may change, and there are no stability guarantees.
* `Stable`: The probe behavior and semantics will not change. There may be bug fixes as needed.
* `Deprecated`: The probe is no longer supported and callers should not expect it to be maintained.

## Reusing code in probes

When multiple probes use the same code, the reused code can be placed in a package under `probes/internal/`
Expand Down

0 comments on commit afcefb0

Please sign in to comment.