signoz.io icon indicating copy to clipboard operation
signoz.io copied to clipboard

add description about running container when installed via Docker/Docker-Swarm

Open zriyansh opened this issue 1 year ago • 0 comments

CONTAINER ID   IMAGE                                          COMMAND                  CREATED          STATUS                    PORTS                                                                            NAMES
01f044c4686a   signoz/frontend:0.25.4                       "nginx -g 'daemon of…"   2 minutes ago   Up 9 seconds                  80/tcp, 0.0.0.0:3301->3301/tcp                                                     signoz-frontend
86aa5b875f9f   gliderlabs/logspout:v3.2.14                  "/bin/logspout syslo…"   2 minutes ago   Up 1 second                   80/tcp                                                                             signoz-logspout
58746f684630   signoz/alertmanager:0.23.1                   "/bin/alertmanager -…"   2 minutes ago   Up 9 seconds                  9093/tcp                                                                           signoz-alertmanager
2cf1ec96bdb3   signoz/query-service:0.25.4                  "./query-service -co…"   2 minutes ago   Up About a minute (healthy)   8080/tcp                                                                           signoz-query-service
e9f0aa66d884   signoz/signoz-otel-collector:0.79.5          "/signoz-collector -…"   2 minutes ago   Up 10 seconds                 0.0.0.0:4317-4318->4317-4318/tcp                                                   signoz-otel-collector
8ff17aadac6a   signoz/signoz-otel-collector:0.79.5          "/signoz-collector -…"   2 minutes ago   Up About a minute             4317-4318/tcp                                                                      signoz-otel-collector-metrics
d3d89d7d4581   clickhouse/clickhouse-server:22.8.8-alpine   "/entrypoint.sh"         2 minutes ago   Up 2 minutes (healthy)        0.0.0.0:8123->8123/tcp, 0.0.0.0:9000->9000/tcp, 0.0.0.0:9181->9181/tcp, 9009/tcp   signoz-clickhouse
9db88aefb6ed   signoz/locust:1.2.3                          "/docker-entrypoint.…"   2 minutes ago   Up 2 minutes                  5557-5558/tcp, 8089/tcp                                                            load-hotrod
60bb3b77b4f7   bitnami/zookeeper:3.7.1                      "/opt/bitnami/script…"   2 minutes ago   Up 2 minutes                  0.0.0.0:2181->2181/tcp, 0.0.0.0:2888->2888/tcp, 0.0.0.0:3888->3888/tcp, 8080/tcp   signoz-zookeeper-1
98c7178b4004   jaegertracing/example-hotrod:1.30            "/go/bin/hotrod-linu…"   9 days ago      Up 2 minutes                  8080-8083/tcp                                                                      hotrod

Like for this docker containers runnings, we may know signoz/frontend is for, but why do we have gliderlabs/logspout[signoz-logspout] ?

and similarly for other containers.

We can add a description section right below the output section covering mainly these things:-

  1. Name of the container
  2. Is it optional or required
  3. Description why that container is needed, what it does, can it be removed or will things break if we remove it.
  4. more details if necessary.

It can be added for architecture of SigNoz section as well

Reason? I recently got asked about why do we have so many pods/containers of SigNoz during its installations, I was asked what are all these and why we need each one of them, I wasn't able to answer to all because it wasn't mentioned anywhere in the docs.

p.s - I made the use SigNoz for logs in prod.

zriyansh avatar Jan 10 '24 20:01 zriyansh