-
Notifications
You must be signed in to change notification settings - Fork 1.7k
WIP: Add long-term vision doc and basic info to README #9
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.
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
Merged
bogdandrutu
merged 3 commits into
open-telemetry:master
from
Omnition:feature/tigran/add-vision-doc
Jun 3, 2019
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 |
---|---|---|
@@ -1,2 +1,8 @@ | ||
# opentelemetry service | ||
OpenTelemetry service | ||
# OpenTelemetry Service | ||
The OpenTelemetry service is a set of components that can collect traces, metrics and eventually other telemetry data (e.g. logs) from processes instrumented by OpenTelementry or other monitoring/tracing libraries (Jaeger, Prometheus, etc.), do aggregation and smart sampling, and export traces and metrics to one or more monitoring/tracing backends. The service will allow to enrich and transform collected telemetry (e.g. add additional attributes or scrab personal information). | ||
|
||
The OpenTelemetry service has two primary modes of operation: Agent (a locally running daemon) and Collector (a standalone running service). | ||
|
||
## Vision | ||
|
||
We have a long-term vision for OpenTelemetry Agent that guides us and helps to decide what features we implement and what the priorities are. See [docs/VISION.md](docs/VISION.md). |
This file contains hidden or 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,23 @@ | ||
# OpenTelemetry Service Long-term Vision | ||
SergeyKanzhelev marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
The following are high-level items that define our long-term vision for OpenTelemetry Service, what we aspire to achieve. This vision is our daily guidance when we design new features and make changes to the Service. | ||
|
||
This is a living document that is expected to evolve over time. | ||
|
||
## Performant | ||
Highly stable and performant under varying loads. Well-behaved under extreme load, with predictable, low resource consumption. | ||
|
||
## Observable | ||
Expose own operational metrics in a clear way. Be an exemplar of observable service. Allow configuring the level of observability (more or less metrics, traces, logs, etc reported). | ||
|
||
## Multi-Data | ||
Support traces, metrics, logs and other relevant data types. | ||
|
||
## Usable Out of the Box | ||
Reasonable default configuration, supports popular protocols, runs and collects out of the box. | ||
|
||
## Extensible | ||
Extensible and customizable without touching the core code. Can create custom agents based on the core and extend with own components. Welcoming 3rd party contribution policy. | ||
|
||
## Unified Codebase | ||
songy23 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
One codebase for daemon (Agent) and standalone service (Collector). |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.