From afcefb05f83c65a9f021e71fc5b71b8ef62b1d36 Mon Sep 17 00:00:00 2001 From: Spencer Schrock Date: Wed, 5 Jun 2024 16:34:37 -0700 Subject: [PATCH] add lifecycle to probe readme Signed-off-by: Spencer Schrock --- probes/README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/probes/README.md b/probes/README.md index 7acd973d76a2..86e914423357 100644 --- a/probes/README.md +++ b/probes/README.md @@ -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/`