-
Notifications
You must be signed in to change notification settings - Fork 5.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
sig-instrumentation: Start charter document
- Loading branch information
Showing
1 changed file
with
52 additions
and
0 deletions.
There are no files selected for viewing
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
# SIG Instrumentation Charter | ||
|
||
This charter adheres to the conventions described in the [Kubernetes Charter README] and uses | ||
the Roles and Organization Management outlined in [sig-governance]. | ||
|
||
## Scope | ||
|
||
Covers best practices for cluster observability through metrics, logging, and | ||
events across all Kubernetes components and development of relevant components. | ||
|
||
### In scope | ||
|
||
Coordinating metric requirements of different SIGs for other components through finding common APIs. | ||
|
||
[Link to SIG section in sigs.yaml][sigs.yaml]. | ||
|
||
#### Code, Binaries and Services | ||
|
||
- Components required for any Kubernetes cluster in regards to observability. | ||
- Interfaces/API definitions required for any Kubernetes cluster in regards to observability. | ||
- Well established but optional components for Kubernetes clusters, if endorsed by member. | ||
- Guidance for instrumentation in order to ensure consistent and high quality instrumentation of core components. | ||
|
||
#### Cross-cutting and Externally Facing Processes | ||
|
||
n/a | ||
|
||
### Out of scope | ||
|
||
- Processing of signals. For example ingesting metrics, logs, events into external systems. | ||
- Predescribing what error states are. | ||
|
||
## Roles and Organization Management | ||
|
||
This sig follows adheres to the Roles and Organization Management outlined in [sig-governance] | ||
and opts-in to updates and modifications to [sig-governance]. | ||
|
||
### Additional responsibilities of Tech Leads | ||
|
||
- No additional responsibilities of Tech Leads | ||
|
||
### Deviations from [sig-governance] | ||
|
||
- This SIG does not have Chairs. | ||
|
||
### Subproject Creation | ||
|
||
By SIG Technical Leads | ||
|
||
[sig-governance]: sig-governance.md | ||
[sigs.yaml]: https://github.com/kubernetes/community/blob/master/sigs.yaml#L964-L1018 | ||
[Kubernetes Charter README]: https://github.com/kubernetes/community/blob/master/committee-steering/governance/README.md |