Skip to content

Commit

Permalink
ecs: Add link to developer README at project root
Browse files Browse the repository at this point in the history
- Use ECR image in yaml template
  • Loading branch information
pingleig committed Jul 13, 2021
1 parent 418f849 commit d94bed9
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 4 deletions.
19 changes: 16 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ This table represents the supported components of AWS OTel Collector in 2020. Th
| prometheusreceiver | attributesprocessor | `awsxrayexporter` | healthcheckextension |
| otlpreceiver | resourceprocessor | `awsemfexporter` | pprofextension |
| `awsecscontainermetricsreceiver`| queuedprocessor | `awsprometheusremotewriteexporter` | zpagesextension |
| `awsxrayreceiver` | batchprocessor | loggingexporter | |
| `awsxrayreceiver` | batchprocessor | loggingexporter | `ecsobserver` |
| `statsdreceiver` | memorylimiter | otlpexporter | |
| zipkinreceiver | tailsamplingprocessor | fileexporter | |
| jaegerreceiver | probabilisticsamplerprocessor | otlphttpexporter | |
Expand All @@ -42,24 +42,31 @@ This table represents the supported components of AWS OTel Collector in 2020. Th


#### AWS OTel Collector AWS Components

* [OpenTelemetry Collector](https://github.com/open-telemetry/opentelemetry-collector/)
* [Trace X-Ray Exporter](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/master/exporter/awsxrayexporter)
* [Metrics EMF Exporter](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/master/exporter/awsemfexporter/README.md)
* [ECS Container Metrics Receiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/master/receiver/awsecscontainermetricsreceiver)
* [StatsD Receiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/statsdreceiver)
* [ECS Observer Extension](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/extension/observer/ecsobserver)

### Getting Started

#### Prerequisites

To build AWS OTel Collector locally, you will need to have Golang installed. You can download and install Golang [here](https://golang.org/doc/install).

#### AWS OTel Collector Configuration

We built in a [default configuration](https://github.com/aws-observability/aws-otel-collector/blob/main/config.yaml) to our docker image and other format of release.
So you can run AWS OTel Collector out of box with the default settings.
Also, AWS OTel Collector configuration uses the same configuration syntax/design from [OpenTelemetry Collector](https://github.com/open-telemetry/opentelemetry-collector)
so you can customize or porting your OpenTelemetry Collector configuration files when running AWS OTel Collector. please refer `Try out AWS OTel Collector` section on configuring AWS OTel Collector.

#### Try out AWS OTel Collector

AWS OTel Collector supports all AWS computing platforms and docker/kubernetes. Here are some examples on how to run AWS OTel Collector to send telemetry data:

* [Run it with Docker](https://github.com/aws-observability/aws-otel-collector/blob/main/docs/developers/docker-demo.md)
* [Run it with ECS](https://github.com/aws-observability/aws-otel-collector/blob/main/docs/developers/ecs-demo.md)
* [Run it with EKS](https://github.com/aws-observability/aws-otel-collector/blob/main/docs/developers/eks-demo.md)
Expand All @@ -68,19 +75,25 @@ AWS OTel Collector supports all AWS computing platforms and docker/kubernetes. H
* [Run it on AWS Debian EC2](https://github.com/aws-observability/aws-otel-collector/blob/main/docs/developers/debian-deb-demo.md)

#### Build Your Own Artifacts

Use the following instruction to build your own AWS OTel Collector artifacts:

* [Build Docker Image](https://github.com/aws-observability/aws-otel-collector/blob/main/docs/developers/build-docker.md)
* [Build RPM/Deb/MSI](https://github.com/aws-observability/aws-otel-collector/blob/main/docs/developers/build-aoc.md)

### Development

See [docs/developers](docs/developers/README.md)

### Release Process

* [Release new version](RELEASING.md)

### Benchmark

The latest performance model result is [here](https://github.com/aws-observability/aws-otel-collector/blob/main/docs/performance_model.md).
The performance test conducted by following the [instruction](https://github.com/aws-observability/aws-otel-test-framework/blob/terraform/docs/get-performance-model.md) here.



### License

AWS OTel Collector is licensed under an Apache 2.0 license.
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Parameters:
# Collector
CollectorImage:
Type: String
Default: 'amazon/aws-otel-collector:latest'
Default: 'public.ecr.aws/aws-observability/aws-otel-collector:latest'
Conditions:
CreateRoles: !Equals
- !Ref CreateIAMRoles
Expand Down
16 changes: 16 additions & 0 deletions docs/developers/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Developer Documentation

Build

- [Binary](build-aoc.md)
- [Docker Image](build-docker.md)

Container Insights for Prometheus Support

- [EKS](container-insight-install-aoc.md)
- [ECS](container-insights-ecs-prometheus.md)

EC2

- [Linux RPM](linux-rpm-demo.md)
- [Winows](windows-other-demo.md)

0 comments on commit d94bed9

Please sign in to comment.