diff --git a/docs/assets/images/jaeger-ui-quickwit-search-traces.png b/docs/assets/images/jaeger-ui-quickwit-search-traces.png new file mode 100644 index 00000000000..d920eb79a82 Binary files /dev/null and b/docs/assets/images/jaeger-ui-quickwit-search-traces.png differ diff --git a/docs/assets/images/jaeger-ui-quickwit-trace-view.png b/docs/assets/images/jaeger-ui-quickwit-trace-view.png new file mode 100644 index 00000000000..f86a75d4bde Binary files /dev/null and b/docs/assets/images/jaeger-ui-quickwit-trace-view.png differ diff --git a/docs/get-started/tutorials/tutorial-hdfs-logs-distributed-search-aws-s3.md b/docs/get-started/tutorials/tutorial-hdfs-logs-distributed-search-aws-s3.md index ad95ec7d539..345f4495049 100644 --- a/docs/get-started/tutorials/tutorial-hdfs-logs-distributed-search-aws-s3.md +++ b/docs/get-started/tutorials/tutorial-hdfs-logs-distributed-search-aws-s3.md @@ -3,7 +3,7 @@ title: Distributed search on AWS S3 description: Index log entries on AWS S3 using an EC2 instance and launch a distributed cluster. tags: [aws, integration] icon_url: /img/tutorials/aws-logo.png -sidebar_position: 2 +sidebar_position: 3 --- In this guide, we will index about 40 million log entries (13 GB decompressed) on AWS S3 using an EC2 instance and launch a three-node distributed search cluster. diff --git a/docs/get-started/tutorials/tutorial-hdfs-logs.md b/docs/get-started/tutorials/tutorial-hdfs-logs.md index bc77a553d7a..d54f1a2a721 100644 --- a/docs/get-started/tutorials/tutorial-hdfs-logs.md +++ b/docs/get-started/tutorials/tutorial-hdfs-logs.md @@ -3,7 +3,7 @@ title: Index a logging dataset locally description: Index log entries on a local machine. tags: [self-hosted, setup] icon_url: /img/quickwit-icon.svg -sidebar_position: 1 +sidebar_position: 2 --- import Tabs from '@theme/Tabs'; diff --git a/docs/get-started/tutorials/tutorial-jaeger.md b/docs/get-started/tutorials/tutorial-jaeger.md new file mode 100644 index 00000000000..3cabd18ada1 --- /dev/null +++ b/docs/get-started/tutorials/tutorial-jaeger.md @@ -0,0 +1,84 @@ +--- +title: Tracing with Jaeger +sidebar_position: 1 +--- + +In this quick start guide, we will set up a Quickwit instance and analyze its own traces with Jaeger using Docker Compose. + +You only need a minute to get Jaeger working with Quickwit storage backend. + +![Jaeger trace view](../../assets/images/jaeger-ui-quickwit-trace-view.png) + + +## Start Quickwit and Jaeger + +Let's use `docker compose` with the following configuration: + +```yaml title="docker-compose.yaml" +version: "3" + +services: + quickwit: + image: quickwit/quickwit:${QW_VERSION:-0.6.5} + volumes: + - ./qwdata:/quickwit/qwdata + ports: + - 7280:7280 + environment: + - QW_ENABLE_OPENTELEMETRY_OTLP_EXPORTER=true + - OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:7281 + command: ["run"] + + jaeger-query: + image: jaegertracing/jaeger-query:1.52 + ports: + - 16686:16686 + environment: + - SPAN_STORAGE_TYPE=grpc-plugin + - GRPC_STORAGE_SERVER=quickwit:7281 + - GRPC_STORAGE_TLS=false +``` + +As you can see in the docker compose file, Quickwit is configured to send its own traces `OTEL_EXPORTER_OTLP_ENDPOINT` to itself `http://localhost:7281`. +On the other side, Jaeger is configured to use a gRPC storage server `quickwit:7281`. + +Save and run the recipe: + +```bash +$ docker compose up +``` + +You should be able to access Quickwit's UI on `http://localhost:7280/` and Jager's UI on `http://localhost:16686/`. + + +## Searching and view traces in Jaeger + +Quickwit generates many traces, let's take a look at some of them: +- `find_traces`: generated by the "Find traces" Jaeger button. +- `get_operations`: generated by Jaeger when it is fetching the list of operations. +- `get_services`: generated by Jaeger when it is fetching the list of services. +- `ingest-spans`: generated when Quickwit receives spans on the gRPC OTLP API. +- ... + +Here are the screenshots of the search and trace view: + +![Jaeger search view](../../assets/images/jaeger-ui-quickwit-search-traces.png) +![Jaeger trace view](../../assets/images/jaeger-ui-quickwit-trace-view.png) + +## Searching traces with Quickwit UI + +You can also use the Quickwit UI at [http://localhost:7280](http://localhost:7280) to search traces. + +Here are a couple of query examples: +- `service_name:quickwit AND events.event_attributes.level:INFO` +- `span_duration_millis:>100` +- `resource_attributes.service.version:v0.6.5` +- `service_name:quickwit` + +That's it! You can level up with the following tutorials to discover all Quickwit features. + +## Next tutorials + + +- [Send traces using an OTEL collector](/docs/distributed-tracing/send-traces/using-otel-collector.md) +- [Send traces from a python web server](/docs/distributed-tracing/send-traces/using-otel-sdk-python.md) diff --git a/docs/get-started/tutorials/add-full-text-search-to-your-olap-db.md b/docs/guides/add-full-text-search-to-your-olap-db.md similarity index 100% rename from docs/get-started/tutorials/add-full-text-search-to-your-olap-db.md rename to docs/guides/add-full-text-search-to-your-olap-db.md diff --git a/docs/log-management/send-logs/send-docker-logs.md b/docs/log-management/send-logs/send-docker-logs.md index 8e1609d0c52..c733fd3ad86 100644 --- a/docs/log-management/send-logs/send-docker-logs.md +++ b/docs/log-management/send-logs/send-docker-logs.md @@ -8,7 +8,7 @@ sidebar_position: 5 To send docker container logs into Quickwit, you just need to setup an OpenTelemetry Collector with the file logs receiver. In this tutorial, we will use `docker compose` to start the collector and Quickwit. -You only needs a minute to get you Quickwit log UI! +You only need a minute to get your Quickwit log UI! ![Quickwit UI Logs](../../assets/images/screenshot-quickwit-ui-docker-compose-logs.png)