@@ -18,9 +18,9 @@ keywords:
1818
1919# 5-Minute Quick Start
2020
21- Get Scout up and running in less than 5 minutes. This guide will help you
22- deploy an OpenTelemetry collector, configure it to send data to Scout, and
23- start collecting telemetry from your applications and infrastructure.
21+ Get Scout up and running in less than 5 minutes. This guide will help you deploy
22+ an OpenTelemetry collector, configure it to send data to Scout, and start
23+ collecting telemetry from your applications and infrastructure.
2424
2525## Time to Complete
2626
@@ -49,15 +49,17 @@ infrastructure. Choose from Docker, Kubernetes, Linux, or AWS ECS options.
4949Perfect for local development and testing environments. Download the
5050configuration and deploy using Docker Compose.
5151
52- See the [ Docker Compose Setup Guide] ( ../instrument/collector-setup/docker-compose-example.md )
52+ See the
53+ [ Docker Compose Setup Guide] ( ../instrument/collector-setup/docker-compose-example.md )
5354for detailed instructions.
5455
5556### Kubernetes
5657
5758Ideal for production deployments on EKS, GKE, or AKS. Install using Helm charts
5859for simplified deployment and management.
5960
60- See the [ Kubernetes Helm Setup Guide] ( ../instrument/collector-setup/kubernetes-helm-setup.md )
61+ See the
62+ [ Kubernetes Helm Setup Guide] ( ../instrument/collector-setup/kubernetes-helm-setup.md )
6163for detailed instructions.
6264
6365### Linux
@@ -78,8 +80,8 @@ detailed instructions on Fargate and EC2 deployments.
7880
7981## Step 2: Configure the OpenTelemetry Collector
8082
81- Once your collector is deployed, configure it to receive telemetry and send
82- data to Scout. Here's a complete configuration example:
83+ Once your collector is deployed, configure it to receive telemetry and send data
84+ to Scout. Here's a complete configuration example:
8385
8486``` yaml showLineNumbers
8587# Extensions provide additional capabilities to the collector
@@ -142,10 +144,9 @@ service:
142144
143145### Configuration Breakdown
144146
145- - **OAuth Extension**: Handles authentication with Scout using OAuth2
146- client credentials flow
147- - **OTLP Receiver**: Accepts telemetry data on ports 4317 (gRPC) and 4318
148- (HTTP)
147+ - **OAuth Extension**: Handles authentication with Scout using OAuth2 client
148+ credentials flow
149+ - **OTLP Receiver**: Accepts telemetry data on ports 4317 (gRPC) and 4318 (HTTP)
149150- **Resource Processor**: Adds environment metadata to all telemetry signals
150151- **Scout Exporter**: Sends data to Scout backend using authenticated OTLP
151152
@@ -156,7 +157,8 @@ service:
1561573. Save the configuration to ` otel-collector-config.yaml`
1571584. Restart the collector to apply changes
158159
159- See the [Scout Exporter Configuration Guide](../instrument/collector-setup/scout-exporter.md)
160+ See the
161+ [Scout Exporter Configuration Guide](../instrument/collector-setup/scout-exporter.md)
160162for complete details and authentication options.
161163
162164# # Step 3: Start Collecting Data
@@ -168,7 +170,8 @@ Now that your collector is running, start sending telemetry data:
168170Instrument your applications to send traces, metrics, and logs :
169171
170172- **Auto-instrumentation**: Get started quickly with zero-code instrumentation
171- for popular frameworks. See [Auto-instrumentation Guides](/instrument/apps/auto-instrumentation/)
173+ for popular frameworks. See
174+ [Auto-instrumentation Guides](/instrument/apps/auto-instrumentation/)
172175- **Custom instrumentation**: Add application-specific telemetry. See
173176 [Custom Instrumentation Guides](/instrument/apps/custom-instrumentation/)
174177
@@ -202,6 +205,9 @@ Monitor your AWS resources automatically:
202205
203206Now that you have Scout running, explore these topics :
204207
208+ - **Send your first trace**: Run a
209+ [Hello World app](/instrument/apps/hello-world) in any of 9 languages to
210+ see traces, logs, and metrics flowing through your collector
205211- **Fine-tune your collector**: Review the
206212 [OTel Collector Configuration Guide](../instrument/collector-setup/otel-collector-config.md)
207213 to optimize your collector setup
@@ -230,5 +236,5 @@ If you're not seeing data in Scout:
230236 \- Advanced collector configuration
231237- [Scout Exporter](../instrument/collector-setup/scout-exporter.md) - Exporter
232238 configuration details
233- - [Dashboards and Alerts](../operate/dashboards-and-alerts.md) - Create visualizations
234- and alerts
239+ - [Dashboards and Alerts](../operate/dashboards-and-alerts.md) - Create
240+ visualizations and alerts
0 commit comments