Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[cmd/opampsupervisor] Add tables showing the Supervisor's current status to its README #26472

Merged
merged 3 commits into from
Sep 6, 2023
Merged

[cmd/opampsupervisor] Add tables showing the Supervisor's current status to its README #26472

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
091c155
Add tables showing the Supervisor's current status to its README
evan-bradley Aug 3, 2023
a942422
Change column order
evan-bradley Sep 5, 2023
999884e
Move key
evan-bradley Sep 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 46 additions & 0 deletions cmd/opampsupervisor/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,49 @@ The supervisor is currently undergoing heavy development and is not ready for an
```

4. The supervisor should connect to the OpAMP server and start a Collector instance.

## Status

The OpenTelemetry OpAMP Supervisor is intended to be the reference
implementation of an OpAMP Supervisor, and as such will support all OpAMP
capabilities. Additionally, it follows a design document for the features it
intends to support.

For a list of open issues related to the Supervisor, see [these issues](https://github.com/open-telemetry/opentelemetry-collector-contrib/issues?q=is%3Aopen+is%3Aissue+label%3Acmd%2Fopampsupervisor).

**Key**:

✅: Fully implemented

⚠️: Implemented with caveats

📅: Planned, but no issue to track implementation

### OpAMP capabilities

| OpAMP capability | Status |
|--------------------------------|----------------------------------------------------------------------------------|
| AcceptsRemoteConfig | ✅ |
| ReportsEffectiveConfig | ⚠️ |
| AcceptsPackages | 📅 |
| ReportsPackageStatuses | 📅 |
| ReportsOwnTraces | 📅 |
| ReportsOwnMetrics | ⚠️ |
| ReportsOwnLogs | 📅 |
| AcceptsOpAMPConnectionSettings | <https://github.com/open-telemetry/opentelemetry-collector-contrib/issues/21043> |
| AcceptsOtherConnectionSettings | <https://github.com/open-telemetry/opentelemetry-collector-contrib/issues/21043> |
| AcceptsRestartCommand | <https://github.com/open-telemetry/opentelemetry-collector-contrib/issues/21077> |
| ReportsHealth | ⚠️ |
| ReportsRemoteConfig | <https://github.com/open-telemetry/opentelemetry-collector-contrib/issues/21079> |

### Supervisor specification features

| Feature | Status |
|--------------------------------------------------------------------|----------------------------------------------------------------------------------|
| Offers Supervisor configuration including configuring capabilities | ✅ |
| Starts and stops a Collector using remote configuration | ⚠️ |
| Communicates with OpAMP extension running in the Collector | <https://github.com/open-telemetry/opentelemetry-collector-contrib/issues/21071> |
| Updates the Collector binary | 📅 |
| Configures the Collector to report it's own metrics over OTLP | 📅 |
| Configures the Collector to report it's own logs over OTLP | 📅 |
| Sanitization or restriction of Collector config | <https://github.com/open-telemetry/opentelemetry-collector-contrib/issues/24310> |