-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added application, system, & otel requirement pages (#12)
* adding agreed requirements * added requirements * update markdownlint * trailing space * Update Requirements/System-Requirements.md Co-authored-by: Reiley Yang <reyang@microsoft.com> * Update Requirements/System-Requirements.md Co-authored-by: Reiley Yang <reyang@microsoft.com> * Update Requirements/README.md Co-authored-by: Reiley Yang <reyang@microsoft.com> * Update Requirements/System-Requirements.md Co-authored-by: Michael Maxwell <mike.ian.maxwell@gmail.com> * lint fix from new update Co-authored-by: Reiley Yang <reyang@microsoft.com> Co-authored-by: Michael Maxwell <mike.ian.maxwell@gmail.com>
- Loading branch information
1 parent
77c2792
commit 4eefb96
Showing
4 changed files
with
99 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,28 @@ | ||
# Application Requirements | ||
|
||
The following requirements were decided upon to define what OpenTelemetry (OTel) | ||
signals the application will produce & when support for future SDKs should be | ||
added: | ||
|
||
1. Every supported language that has a GA Traces or Metrics SDK must have at | ||
least 1 service example. | ||
|
||
* Mobile support (Swift) is not an initial priority and not included in the | ||
above requirement. | ||
|
||
2. Application processes must be language independent. | ||
|
||
* gRPC is preferred where available and HTTP is to be used where it is not. | ||
|
||
3. Services should be architected to be modular components that can be switched out. | ||
|
||
* Individual services can and should be encouraged to have multiple language | ||
options available. | ||
|
||
4. The architecture must allow for the possible integration of platform generic | ||
components like a database, queue, or blob storage. | ||
|
||
* There is no requirement for a particular component type - at least 1 generic | ||
component should be present in general. | ||
|
||
5. A load generator must be provided to simulate user load against the demo. |
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,24 @@ | ||
# OpenTelemetry Requirements | ||
|
||
The following requirements were decided upon to define what OpenTelemetry (OTel) | ||
signals the application will produce & when support for future SDKs should be | ||
added: | ||
|
||
1. The demo must produce OTel logs, traces, & metrics out of the box for | ||
languages that have a GA SDK. | ||
|
||
2. Languages that have a Beta SDK available may be included but are not required | ||
like GA SDKs. | ||
|
||
3. Native OTel metrics should be produced where possible. | ||
|
||
4. Both manual instrumentation and instrumentation libraries | ||
(auto-instrumentation) should be demonstrated in each language. | ||
|
||
5. All data should be exported to the Collector first. | ||
|
||
6. The Collector must be configurable to allow for a variety of consumption | ||
experiences but default tools must be selected for each signal. | ||
|
||
7. The demo application architecture using the Collector should be designed to | ||
be a best practices reference architecture. |
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,27 @@ | ||
# OpenTelemetry Community Demo Requirements | ||
|
||
The following documents capture the Application, OpenTelemetry (OTel), and System | ||
requirements for our shared demo application. These were decided upon in the | ||
ongoing SIG meeting. | ||
|
||
1. [Application Requirements](./Application-Requirements.md) | ||
|
||
2. [OpenTelemetry Requirements](./OpenTelemetry-Requirements.md) | ||
|
||
3. [System Requirements](./System-Requirements.md) | ||
|
||
## Target Personas | ||
|
||
We're building the demo application with several different target personas in mind: | ||
|
||
1. **Enthusiasts** at a company that can use the demo app as an individual to | ||
advocate for OTel within their organization. | ||
|
||
2. **Developers** with specific language skills who want to see a larger picture | ||
view. | ||
|
||
3. **APM Vendors** who can evaluate OTel in general or need to produce a demo of | ||
their OTel capabilities for customers. | ||
|
||
4. **Enterprises** considering adopting OTel and interested in understanding | ||
what a production-lite experience would be. |
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,20 @@ | ||
# System Requirements | ||
|
||
To ensure the demo runs correctly please ensure your environment meets the | ||
following system requirements: | ||
|
||
1. Your system must meet [Docker Desktop](https://docs.docker.com/desktop) | ||
system requirements or you should use your preferred Cloud Service. | ||
|
||
2. The demo must be able to work on the following Operating Systems (OS): | ||
Linux, macOS and Windows with documentation provided for each OS. | ||
|
||
## Docker Requirements | ||
|
||
Docker requirements for each operating system can be found below: | ||
|
||
1. [Linux](https://docs.docker.com/desktop/linux/install/) | ||
|
||
2. [Mac](https://docs.docker.com/desktop/mac/install/) | ||
|
||
3. [Windows](https://docs.docker.com/desktop/windows/install/) |