A public repository on Docker Hub offers the latest versions of the Satellite.

You configure the Satellites using environment variables. Please see Satellite Configuration Parameters for a full listing and expanded explanations of variables and recommended settings. You can also use this template and fill in your own values for the variables (defaults are entered for you, but you can change them).

If you want to use yaml instead of the command line, you can use the yaml file in the AWS configuration topic.

If you are happy with the default port numbers and don’t need TLS, you only need to modify the following settings:
* satellite_key
* pool
* bytes_per_project

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
docker run
-e COLLECTOR_SATELLITE_KEY=
-e COLLECTOR_POOL=
-e COLLECTOR_GUID=
-e COLLECTOR_STATSD_HOST=
-e COLLECTOR_STATSD_PORT=
-e COLLECTOR_STATSD_EXPORT_STATSD=
#-----Only if using Datadog for Satellite Metrics----
-e COLLECTOR_STATSD_EXPORT_DOGSTATSD=
-e COLLECTOR_STATSD_DOGSTATSD_TAGS=
#-----------------------------------------------------
-e COLLECTOR_STATSD_PREFIX=lightstep
-e COLLECTOR_STATSD_SATELLITE_PREFIX=satellite
-e COLLECTOR_STATSD_CLIENT_PREFIX=client
-e COLLECTOR_DIGNOSTIC_PORT=8000 -p 8000:8000
-e COLLECTOR_ADMIN_PLAIN_PORT=8180 -p 8180:8180
-e COLLECTOR_ADMIN_SECURE_PORT= 8181 -p 8181:8181
-e COLLECTOR_HTTP_PLAIN_PORT=8182 -p 8182:8182
-e COLLECTOR_HTTP_SECURE_PORT=8183 -p 8183:8183
-e COLLECTOR_GRPC_PLAIN_PORT=8184 -p 8184:8184
-e COLLECTOR_GRPC_SECURE_PORT=8185 -p 8185:8185
-e COLLECTOR_PLAIN_PORT=8186 -p 8186:8186
-e COLLECTOR_SECURE_PORT=8187 -p 8187:8187
-e COLLECTOR_REPORTER_BYTES_PER_PROJECT=1000000000
-e COLLECTOR_REPORTER_BYTES_PER_PROJECT_OVERRIDES= ??
-e COLLECTOR_TLS_CERT_PREFIX= ??
-e COLLECTOR_DISABLE_ACCESS_TOKEN_CHECKING=
-e COLLECTOR_PROJECT_NAME=
-e COLLECTOR_INGESTION_TAGS
lightstep/collector:latest

Here is an example using a Docker Compose file. This configuration sends Spans over http on port 8182 with secure traffic configured to go over port 8183. Change the COLLECTOR_API_KEY to your satellite key for your project, save it as docker-compose.yml and then do docker-compose up.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
version: '3'
services:
  satellite:
    image: lightstep/collector:latest
    environment:
      - COLLECTOR_SATELLITE_KEY=someLongRandomStringOfCharacaters
      - COLLECTOR_DIAGNOSTIC_PORT=8000
      - COLLECTOR_ADMIN_PLAIN_PORT=8180
      - COLLECTOR_HTTP_PLAIN_PORT=8182
      - COLLECTOR_HTTP_SECURE_PORT=8183
      - COLLECTOR_REPORTER_BYTES_PER_PROJECT=1000000000
    ports:
      - "8000:8000" #Diagnostics
      - "8180:8180" #COLLECTOR_ADMIN_PLAIN_PORT, Required for health checks
      - "8182:8182" #COLLECTOR_HTTP_PLAIN_PORT,  Unsecure traffic, or secure traffic that terminates it's secure status before it hits the satellite
      - "8183:8183" #COLLECTOR_HTTP_SECURE_PORT, for Secure traffic

After startup, check the diagnostics page (http://{satellite_host}:8000/diagnostics) to view the Satellite configuration. When starting from command line as in the above example, the configuration will also be directed to stdout, which you can inspect for troubleshooting if the diagnostics page isn’t reachable. Follow these instructions to further validate your installation and troubleshoot any issues.

You configure your Lightstep tracers to communicate with your Satellites by providing their location. If you are using a single Satellite, you provide the DNS name or IP address of that Satellite. For more than one, use the name or address of the load balancer you’ve deployed. Find out how to do that in the language-specific Quick Start guides.

By default, client libraries use secure connections. If you’ve configured your Satellites to use plainport connections, you must configure your tracer appropriately.