diff --git a/README.md b/README.md index b676c93c2d..df1c6313c6 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@

- + Get Started!  👉 

@@ -145,7 +145,7 @@ You can: ## Cloud-based Managed Tracetest (Free to get started!) -The easiest and most reliable way to test microservices and distributed apps with OpenTelemetry distributed traces is signing up for free at [app.tracetest.io](https://app.tracetest.io/). After creating an account, getting started is as easy as [installing the Tracetest Agent](https://docs.tracetest.io/getting-started/installation). +The easiest and most reliable way to test microservices and distributed apps with OpenTelemetry distributed traces is signing up for free at [app.tracetest.io](https://app.tracetest.io/). After creating an account, getting started is as easy as [installing the Tracetest Agent](https://docs.tracetest.io/getting-started/overview). ## Enterprise Self-hosted Tracetest (1 month free trial!) @@ -161,7 +161,7 @@ Get the same experience as with the Cloud-based Managed Tracetest but self-hoste curl -L https://raw.githubusercontent.com/kubeshop/tracetest/main/install-cli.sh | bash -s ``` -> [:gear: Read the CLI installation docs for more options and instructions.](https://docs.tracetest.io/getting-started/installation#install-the-tracetest-cli) +> [:gear: Read the CLI installation docs for more options and instructions.](https://docs.tracetest.io/getting-started/install-cli) ### 2️⃣ Install the Tracetest Server @@ -177,7 +177,7 @@ Or, install Tracetest with Helm. The Tracetest Helm charts are located [here](ht helm install tracetest kubeshop/tracetest --namespace=tracetest --create-namespace ``` -> [:gear: Read the Server installation docs for more options and instructions.](https://docs.tracetest.io/getting-started/installation#install-the-tracetest-server) +> [:gear: Read the Server installation docs for more options and instructions.](https://docs.tracetest.io/core/getting-started/overview) ### 3️⃣ Open Tracetest @@ -204,7 +204,7 @@ Check out the [Opening Tracetest guide](https://docs.tracetest.io/core/getting-s - Use test definition files and the Tracetest CLI to [enable Gitops flows and CI/CD automation](https://docs.tracetest.io/ci-cd-automation/overview). - [Tracetest CLI](https://docs.tracetest.io/cli/cli-installation-reference) allows importing & exporting tests, running tests, and more. - [Version tests](https://docs.tracetest.io/concepts/versioning/) as the definition of the test is altered. -- The [guided install](https://docs.tracetest.io/getting-started/installation) can include [an example "Pokeshop" microservice](https://docs.tracetest.io/live-examples/pokeshop/overview) that is instrumented with OpenTelemetry to use as an example application under test. +- The [guided install](https://docs.tracetest.io/getting-started/overview) can include [an example "Pokeshop" microservice](https://docs.tracetest.io/live-examples/pokeshop/overview) that is instrumented with OpenTelemetry to use as an example application under test. - Create [environment variables](https://docs.tracetest.io/concepts/environments) to assert the same behavior across multiple environments (dev, staging, and production, for example) - Create [test outputs](https://docs.tracetest.io/web-ui/creating-test-outputs/) by defining a variable based on the information contained in a particular span's attributes. - Run [ad-hoc tests](https://docs.tracetest.io/concepts/ad-hoc-testing) by using undefined variables to enable supplying variables at runtime. diff --git a/docs/docs/ci-cd-automation/overview.mdx b/docs/docs/ci-cd-automation/overview.mdx index ebdc45501e..f6d2995a2a 100644 --- a/docs/docs/ci-cd-automation/overview.mdx +++ b/docs/docs/ci-cd-automation/overview.mdx @@ -23,7 +23,7 @@ You can find guides for: If you want to see more examples with other CI/CD tools, let us know by [opening an issue in GitHub](https://github.com/kubeshop/tracetest/issues/new/choose)! ::: -Tracetest is designed to work with all CI/CD platforms and automation tools. To enable Tracetest to run in CI/CD environments, make sure to [install the Tracetest CLI](../getting-started/installation.mdx) and configure it to access your [Tracetest server](../core/configuration/server.mdx). +Tracetest is designed to work with all CI/CD platforms and automation tools. To enable Tracetest to run in CI/CD environments, make sure to [install the Tracetest CLI and configure it to access your Tracetest account](/getting-started/install-cli). To read more about integrating Tracetest with CI/CD tools, check out tutorials in our blog: diff --git a/docs/docs/ci-cd-automation/tekton-pipeline.mdx b/docs/docs/ci-cd-automation/tekton-pipeline.mdx index ef86288eed..c44945370e 100644 --- a/docs/docs/ci-cd-automation/tekton-pipeline.mdx +++ b/docs/docs/ci-cd-automation/tekton-pipeline.mdx @@ -74,7 +74,7 @@ https://storage.googleapis.com/tekton-releases/triggers/latest/interceptors.yaml ## 2. Install Tracetest CLI -Install Tracetest CLI by following [these instructions](https://docs.tracetest.io/getting-started/installation) for your OS. +Install Tracetest CLI by following [these instructions](/getting-started/install-cli) for your OS. ```bash # MacOS example diff --git a/docs/docs/ci-cd-automation/testkube-pipeline.mdx b/docs/docs/ci-cd-automation/testkube-pipeline.mdx index 4a183108e6..91b41b41c7 100644 --- a/docs/docs/ci-cd-automation/testkube-pipeline.mdx +++ b/docs/docs/ci-cd-automation/testkube-pipeline.mdx @@ -76,7 +76,7 @@ This guide will show how to use Testkube alongside Tracetest to run scheduled Tr **Tracetest account**: -- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/installation) docs. +- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/overview) docs. - Create an [organization](/concepts/organizations) and [environment](/concepts/environments). - Deploy the [Tracetest Agent](/configuration/agent) in your cluster. - Create an [environment token](/concepts/environment-tokens). diff --git a/docs/docs/cli/cli-installation-reference.mdx b/docs/docs/cli/cli-installation-reference.mdx index 6bb4b65f8e..1f783f45df 100644 --- a/docs/docs/cli/cli-installation-reference.mdx +++ b/docs/docs/cli/cli-installation-reference.mdx @@ -22,7 +22,7 @@ Tracetest has a command line interface (CLI) which includes: The CLI is used to run tests, download or upload tests, and manage Tracetest capability and resources. :::tip Want more info? -Read more about the installation guide [here](/getting-started/installation). +Read more about the installation guide [here](/getting-started/overview). ::: ## Installing the Tracetest CLI in different operating systems diff --git a/docs/docs/concepts/agent.mdx b/docs/docs/concepts/agent.mdx index 035b93f8fc..ef7524bd3a 100644 --- a/docs/docs/concepts/agent.mdx +++ b/docs/docs/concepts/agent.mdx @@ -43,5 +43,5 @@ Enable and configure the tracing backend you're using via the trace ingestion ta ![](https://res.cloudinary.com/djwdcmwdz/image/upload/v1715929575/docs/tracetest-private-agent-marketechture-may-17_jiyf1t.png) :::note -Want to start Tracetest Agent? Check out [this page to get started](../getting-started/installation). +Want to start Tracetest Agent? Check out [this page to get started](/getting-started/install-agent). ::: diff --git a/docs/docs/examples-tutorials/recipes/running-playwright-performance-tests-with-artillery-and-tracetest.mdx b/docs/docs/examples-tutorials/recipes/running-playwright-performance-tests-with-artillery-and-tracetest.mdx index 1c7f01110a..f45ca8ba66 100644 --- a/docs/docs/examples-tutorials/recipes/running-playwright-performance-tests-with-artillery-and-tracetest.mdx +++ b/docs/docs/examples-tutorials/recipes/running-playwright-performance-tests-with-artillery-and-tracetest.mdx @@ -64,7 +64,7 @@ The [`artillery-engine-playwright` npm package](https://www.npmjs.com/package/ar **Tracetest Account**: -- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/installation) docs. +- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/overview) docs. - Have access to the environment's [agent API key](https://app.tracetest.io/retrieve-token). **Docker**: Have [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/) installed on your machine. diff --git a/docs/docs/examples-tutorials/recipes/running-python-app-with-opentelemetry-collector-and-tracetest.mdx b/docs/docs/examples-tutorials/recipes/running-python-app-with-opentelemetry-collector-and-tracetest.mdx index 5a71cc1b09..8a3ddd2206 100644 --- a/docs/docs/examples-tutorials/recipes/running-python-app-with-opentelemetry-collector-and-tracetest.mdx +++ b/docs/docs/examples-tutorials/recipes/running-python-app-with-opentelemetry-collector-and-tracetest.mdx @@ -31,7 +31,7 @@ This is a simple quick start on how to configure a Python app to use OpenTelemet **Tracetest Account**: -- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/installation) docs. +- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/overview) docs. - Have access to the environment's [agent API key](https://app.tracetest.io/retrieve-token). **Docker**: Have [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/) installed on your machine. diff --git a/docs/docs/examples-tutorials/recipes/running-tests-with-tracetest-graphql-pokeshop.mdx b/docs/docs/examples-tutorials/recipes/running-tests-with-tracetest-graphql-pokeshop.mdx index 4ffbc20b46..04e6295dff 100644 --- a/docs/docs/examples-tutorials/recipes/running-tests-with-tracetest-graphql-pokeshop.mdx +++ b/docs/docs/examples-tutorials/recipes/running-tests-with-tracetest-graphql-pokeshop.mdx @@ -43,7 +43,7 @@ Other impactful benefits of using traces as test specs are: **Tracetest Account**: -- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/installation) docs. +- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/overview) docs. - Have access to the environment's [agent API key](https://app.tracetest.io/retrieve-token). **Docker**: Have [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/) installed on your machine. diff --git a/docs/docs/examples-tutorials/recipes/running-tests-with-tracetest-playwright-engine.mdx b/docs/docs/examples-tutorials/recipes/running-tests-with-tracetest-playwright-engine.mdx index 102ab6cd3e..829a1576fb 100644 --- a/docs/docs/examples-tutorials/recipes/running-tests-with-tracetest-playwright-engine.mdx +++ b/docs/docs/examples-tutorials/recipes/running-tests-with-tracetest-playwright-engine.mdx @@ -48,7 +48,7 @@ Another big benefit of using traces as test specs is that you can: **Tracetest Account**: -- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/installation) docs. +- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/overview) docs. - Have access to the environment's [agent API key](https://app.tracetest.io/retrieve-token). **Docker**: Have [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/) installed on your machine. diff --git a/docs/docs/examples-tutorials/recipes/running-tracetest-with-aws-x-ray-adot.mdx b/docs/docs/examples-tutorials/recipes/running-tracetest-with-aws-x-ray-adot.mdx index fa3853b5c1..e2d4bac3b0 100644 --- a/docs/docs/examples-tutorials/recipes/running-tracetest-with-aws-x-ray-adot.mdx +++ b/docs/docs/examples-tutorials/recipes/running-tracetest-with-aws-x-ray-adot.mdx @@ -38,7 +38,7 @@ This is a simple quick start guide on how to configure a Node.js app to use inst **Tracetest Account**: -- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/installation) docs. +- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/overview) docs. - Have access to the environment's [agent API key](https://app.tracetest.io/retrieve-token). **AWS Account**: @@ -71,7 +71,7 @@ Follow along with the sections below for an in detail breakdown of what the exam ## Project Structure -The project contains the [Tracetest Agent](/getting-started/installation#install-the-tracetest-agent), and a Node.js app. +The project contains the [Tracetest Agent](/getting-started/install-agent), and a Node.js app. The `docker-compose.yaml` file in the root directory of the quick start runs the Node.js app, [AWS Distro for OpenTelemetry (ADOT)](https://aws-otel.github.io/docs/getting-started/collector), and the [Tracetest Agent](/concepts/agent) setup. diff --git a/docs/docs/examples-tutorials/recipes/running-tracetest-with-aws-x-ray-pokeshop.mdx b/docs/docs/examples-tutorials/recipes/running-tracetest-with-aws-x-ray-pokeshop.mdx index 6b25c7cfe8..c1e81d1a06 100644 --- a/docs/docs/examples-tutorials/recipes/running-tracetest-with-aws-x-ray-pokeshop.mdx +++ b/docs/docs/examples-tutorials/recipes/running-tracetest-with-aws-x-ray-pokeshop.mdx @@ -40,7 +40,7 @@ This is a simple quick start guide on how to configure a fully instrumented API **Tracetest Account**: -- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/installation) docs. +- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/overview) docs. - Have access to the environment's [agent API key](https://app.tracetest.io/retrieve-token). **AWS Account**: @@ -73,7 +73,7 @@ Follow along with the sections below for an in detail breakdown of what the exam ## Project Structure -The project contains the [Tracetest Agent](/getting-started/installation#install-the-tracetest-agent), and the [Pokeshop Demo app](/live-examples/pokeshop/overview). +The project contains the [Tracetest Agent](/getting-started/install-agent), and the [Pokeshop Demo app](/live-examples/pokeshop/overview). The `docker-compose.yaml` file in the root directory of the quick start runs the Pokeshop Demo app, [AWS Distro for OpenTelemetry (ADOT)](https://aws-otel.github.io/docs/getting-started/collector), and the [Tracetest Agent](/concepts/agent) setup. diff --git a/docs/docs/examples-tutorials/recipes/running-tracetest-with-aws-x-ray.mdx b/docs/docs/examples-tutorials/recipes/running-tracetest-with-aws-x-ray.mdx index 1468d0060f..4661edb068 100644 --- a/docs/docs/examples-tutorials/recipes/running-tracetest-with-aws-x-ray.mdx +++ b/docs/docs/examples-tutorials/recipes/running-tracetest-with-aws-x-ray.mdx @@ -34,7 +34,7 @@ This is a simple quick start guide on how to configure a Node.js app to use inst **Tracetest Account**: -- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/installation) docs. +- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/overview) docs. - Have access to the environment's [agent API key](https://app.tracetest.io/retrieve-token). **AWS Account**: @@ -67,7 +67,7 @@ Follow along with the sections below for an in detail breakdown of what the exam ## Project Structure -The project contains [Tracetest Agent](/getting-started/installation#install-the-tracetest-agent), and a Node.js app. +The project contains [Tracetest Agent](/getting-started/install-agent), and a Node.js app. The `docker-compose.yaml` file in the root directory of the quick start runs the Node.js app, [X-Ray Daemon](https://docs.aws.amazon.com/xray/latest/devguide/xray-daemon.html), and the [Tracetest Agent](/concepts/agent) setup. diff --git a/docs/docs/examples-tutorials/recipes/running-tracetest-with-azure-app-insights-collector.mdx b/docs/docs/examples-tutorials/recipes/running-tracetest-with-azure-app-insights-collector.mdx index 3908a74d4b..ebc8f92e6c 100644 --- a/docs/docs/examples-tutorials/recipes/running-tracetest-with-azure-app-insights-collector.mdx +++ b/docs/docs/examples-tutorials/recipes/running-tracetest-with-azure-app-insights-collector.mdx @@ -41,7 +41,7 @@ This is a simple quick start guide on how to configure a Node.js app to use inst **Tracetest Account**: -- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/installation) docs. +- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/overview) docs. - Have access to the environment's [agent API key](https://app.tracetest.io/retrieve-token). **Azure Account**: @@ -75,7 +75,7 @@ Follow along with the sections below for an in detail breakdown of what the exam ## Project Structure -The project contains the [Tracetest Agent](/getting-started/installation#install-the-tracetest-agent), and a Node.js app. +The project contains the [Tracetest Agent](/getting-started/install-agent), and a Node.js app. The `docker-compose.yaml` file in the root directory of the quick start runs the Node.js app, Elasticsearch, Elastic APM server, OpenTelemetry Collector, and the [Tracetest Agent](/concepts/agent) setup. diff --git a/docs/docs/examples-tutorials/recipes/running-tracetest-with-azure-app-insights-pokeshop.mdx b/docs/docs/examples-tutorials/recipes/running-tracetest-with-azure-app-insights-pokeshop.mdx index 14effffcc3..c6b429e271 100644 --- a/docs/docs/examples-tutorials/recipes/running-tracetest-with-azure-app-insights-pokeshop.mdx +++ b/docs/docs/examples-tutorials/recipes/running-tracetest-with-azure-app-insights-pokeshop.mdx @@ -41,7 +41,7 @@ This is a simple quick start guide on how to configure a fully instrumented API **Tracetest Account**: -- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/installation) docs. +- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/overview) docs. - Have access to the environment's [agent API key](https://app.tracetest.io/retrieve-token). **Azure Account**: diff --git a/docs/docs/examples-tutorials/recipes/running-tracetest-with-azure-app-insights.mdx b/docs/docs/examples-tutorials/recipes/running-tracetest-with-azure-app-insights.mdx index 2a033808cc..2a4af65b63 100644 --- a/docs/docs/examples-tutorials/recipes/running-tracetest-with-azure-app-insights.mdx +++ b/docs/docs/examples-tutorials/recipes/running-tracetest-with-azure-app-insights.mdx @@ -37,7 +37,7 @@ This is a simple quick start guide on how to configure a Node.js app to use inst **Tracetest Account**: -- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/installation) docs. +- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/overview) docs. - Have access to the environment's [agent API key](https://app.tracetest.io/retrieve-token). **Azure Account**: @@ -72,7 +72,7 @@ Follow along with the sections below for an in detail breakdown of what the exam ## Project Structure -The project contains [Tracetest Agent](/getting-started/installation#install-the-tracetest-agent), and a Node.js app. +The project contains [Tracetest Agent](/getting-started/install-agent), and a Node.js app. The `docker-compose.yaml` file in the root directory of the quick start runs the Node.js app, and the [Tracetest Agent](/concepts/agent) setup. diff --git a/docs/docs/examples-tutorials/recipes/running-tracetest-with-datadog.mdx b/docs/docs/examples-tutorials/recipes/running-tracetest-with-datadog.mdx index 00e69865be..7cf69a5167 100644 --- a/docs/docs/examples-tutorials/recipes/running-tracetest-with-datadog.mdx +++ b/docs/docs/examples-tutorials/recipes/running-tracetest-with-datadog.mdx @@ -28,7 +28,7 @@ This is a simple sample app on how to configure the [OpenTelemetry Demo `v1.3.0` **Tracetest Account**: -- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/installation) docs. +- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/overview) docs. - Have access to the environment's [agent API key](https://app.tracetest.io/retrieve-token). **Docker**: Have [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/) installed on your machine. diff --git a/docs/docs/examples-tutorials/recipes/running-tracetest-with-dynatrace.mdx b/docs/docs/examples-tutorials/recipes/running-tracetest-with-dynatrace.mdx index f2d05d7379..72edbb05db 100644 --- a/docs/docs/examples-tutorials/recipes/running-tracetest-with-dynatrace.mdx +++ b/docs/docs/examples-tutorials/recipes/running-tracetest-with-dynatrace.mdx @@ -28,7 +28,7 @@ This is a simple sample app on how to configure the [OpenTelemetry Demo `v1.3.0` **Tracetest Account**: -- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/installation) docs. +- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/overview) docs. - Have access to the environment's [agent API key](https://app.tracetest.io/retrieve-token). **Docker**: Have [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/) installed on your machine. diff --git a/docs/docs/examples-tutorials/recipes/running-tracetest-with-elastic-opentelemetry.mdx b/docs/docs/examples-tutorials/recipes/running-tracetest-with-elastic-opentelemetry.mdx index c7e3f199e4..891f1cfea1 100644 --- a/docs/docs/examples-tutorials/recipes/running-tracetest-with-elastic-opentelemetry.mdx +++ b/docs/docs/examples-tutorials/recipes/running-tracetest-with-elastic-opentelemetry.mdx @@ -36,7 +36,7 @@ This is a simple quick start on how to configure a Node.js app to use OpenTeleme **Tracetest Account**: -- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/installation) docs. +- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/overview) docs. - Have access to the environment's [agent API key](https://app.tracetest.io/retrieve-token). **Docker**: Have [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/) installed on your machine. @@ -63,7 +63,7 @@ Follow along with the sections below for an in detail breakdown of what the exam ## Project Structure -The project contains [Tracetest Agent](/getting-started/installation#install-the-tracetest-agent), [Elastic APM server](https://github.com/elastic/apm-server), [Elasticsearch](https://github.com/elastic/elasticsearch), [OpenTelemetry Collector](https://github.com/open-telemetry/opentelemetry-collector-contrib), and a Node.js app. +The project contains [Tracetest Agent](/getting-started/install-agent), [Elastic APM server](https://github.com/elastic/apm-server), [Elasticsearch](https://github.com/elastic/elasticsearch), [OpenTelemetry Collector](https://github.com/open-telemetry/opentelemetry-collector-contrib), and a Node.js app. The `docker-compose.yaml` file in the root directory of the quick start runs the Node.js app, Elasticsearch, Elastic APM server, OpenTelemetry Collector, and the [Tracetest Agent](/concepts/agent) setup. diff --git a/docs/docs/examples-tutorials/recipes/running-tracetest-with-elasticapm.mdx b/docs/docs/examples-tutorials/recipes/running-tracetest-with-elasticapm.mdx index 14ac203c75..b7ba8b3647 100644 --- a/docs/docs/examples-tutorials/recipes/running-tracetest-with-elasticapm.mdx +++ b/docs/docs/examples-tutorials/recipes/running-tracetest-with-elasticapm.mdx @@ -33,7 +33,7 @@ This is a simple quick start on how to configure a Node.js app to use Elastic AP **Tracetest Account**: -- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/installation) docs. +- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/overview) docs. - Have access to the environment's [agent API key](https://app.tracetest.io/retrieve-token). **Docker**: Have [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/) installed on your machine. @@ -60,7 +60,7 @@ Follow along with the sections below for an in detail breakdown of what the exam ## Project Structure -The project contains [Tracetest Agent](/getting-started/installation#install-the-tracetest-agent), [OpenTelemetry Collector](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main), and a Node.js app. +The project contains [Tracetest Agent](/getting-started/install-agent), [OpenTelemetry Collector](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main), and a Node.js app. The `docker-compose.yaml` file in the root directory of the quick start runs the Node.js app, Elasticsearch, Elastic APM server, and the [Tracetest Agent](/concepts/agent) setup. diff --git a/docs/docs/examples-tutorials/recipes/running-tracetest-with-grafana-cloud-tempo-pokeshop.mdx b/docs/docs/examples-tutorials/recipes/running-tracetest-with-grafana-cloud-tempo-pokeshop.mdx index 3288a5f1d8..b6d196ee3d 100644 --- a/docs/docs/examples-tutorials/recipes/running-tracetest-with-grafana-cloud-tempo-pokeshop.mdx +++ b/docs/docs/examples-tutorials/recipes/running-tracetest-with-grafana-cloud-tempo-pokeshop.mdx @@ -38,7 +38,7 @@ This is a simple quick start guide on how to configure a fully instrumented API **Tracetest Account**: -- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/installation) docs. +- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/overview) docs. - Have access to the environment's [agent API key](https://app.tracetest.io/retrieve-token). **Grafana Cloud Account** @@ -71,7 +71,7 @@ Follow along with the sections below for an in detail breakdown of what the exam ## Project Structure -The project contains the [Tracetest Agent](/getting-started/installation#install-the-tracetest-agent), and the [Pokeshop Demo app](/live-examples/pokeshop/overview). +The project contains the [Tracetest Agent](/getting-started/install-agent), and the [Pokeshop Demo app](/live-examples/pokeshop/overview). The `docker-compose.yaml` file in the root directory of the quick start runs the Pokeshop Demo app, [OpenTelemetry Collector](https://github.com/open-telemetry/opentelemetry-collector-contrib), and the [Tracetest Agent](/concepts/agent) setup. diff --git a/docs/docs/examples-tutorials/recipes/running-tracetest-with-grafana-cloud-tempo.mdx b/docs/docs/examples-tutorials/recipes/running-tracetest-with-grafana-cloud-tempo.mdx index 456c0a4918..ad56ead64f 100644 --- a/docs/docs/examples-tutorials/recipes/running-tracetest-with-grafana-cloud-tempo.mdx +++ b/docs/docs/examples-tutorials/recipes/running-tracetest-with-grafana-cloud-tempo.mdx @@ -36,7 +36,7 @@ This is a simple quick start on how to configure a Node.js app to use OpenTeleme **Tracetest Account**: -- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/installation) docs. +- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/overview) docs. - Have access to the environment's [agent API key](https://app.tracetest.io/retrieve-token). **Grafana Cloud Account** @@ -69,7 +69,7 @@ Follow along with the sections below for an in detail breakdown of what the exam ## Project Structure -The project contains [Tracetest Agent](/getting-started/installation#install-the-tracetest-agent), [OpenTelemetry Collector](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main), [Grafana Tempo](https://github.com/grafana/tempo), and a Node.js app. +The project contains [Tracetest Agent](/getting-started/install-agent), [OpenTelemetry Collector](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main), [Grafana Tempo](https://github.com/grafana/tempo), and a Node.js app. The `docker-compose.yaml` file in the root directory of the quick start runs the Node.js app and the [Tracetest Agent](/concepts/agent) setup. diff --git a/docs/docs/examples-tutorials/recipes/running-tracetest-with-grafana-tempo-pokeshop.mdx b/docs/docs/examples-tutorials/recipes/running-tracetest-with-grafana-tempo-pokeshop.mdx index f1e4faa523..193a822a34 100644 --- a/docs/docs/examples-tutorials/recipes/running-tracetest-with-grafana-tempo-pokeshop.mdx +++ b/docs/docs/examples-tutorials/recipes/running-tracetest-with-grafana-tempo-pokeshop.mdx @@ -34,7 +34,7 @@ This is a simple quick start guide on how to configure a fully instrumented API **Tracetest Account**: -- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/installation) docs. +- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/overview) docs. - Have access to the environment's [agent API key](https://app.tracetest.io/retrieve-token). **Docker**: Have [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/) installed on your machine. @@ -65,7 +65,7 @@ The project is built with Docker Compose. ### 1. Tracetest -The project contains [Tracetest Agent](/getting-started/installation#install-the-tracetest-agent), [OpenTelemetry Collector](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main), and a Node.js app. +The project contains [Tracetest Agent](/getting-started/install-agent), [OpenTelemetry Collector](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main), and a Node.js app. The `docker-compose.yaml` file in the root directory of the quick start runs the Node.js app and the [Tracetest Agent](/concepts/agent) setup. diff --git a/docs/docs/examples-tutorials/recipes/running-tracetest-with-honeycomb.mdx b/docs/docs/examples-tutorials/recipes/running-tracetest-with-honeycomb.mdx index dc7bd6d414..59f20160c8 100644 --- a/docs/docs/examples-tutorials/recipes/running-tracetest-with-honeycomb.mdx +++ b/docs/docs/examples-tutorials/recipes/running-tracetest-with-honeycomb.mdx @@ -34,7 +34,7 @@ This is a quick start on how to configure a Node.js app to use OpenTelemetry ins **Tracetest Account**: -- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/installation) docs. +- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/overview) docs. - Have access to the environment's [agent API key](https://app.tracetest.io/retrieve-token). **Docker**: Have [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/) installed on your machine. diff --git a/docs/docs/examples-tutorials/recipes/running-tracetest-with-jaeger.mdx b/docs/docs/examples-tutorials/recipes/running-tracetest-with-jaeger.mdx index f6998422ca..e238c0f510 100644 --- a/docs/docs/examples-tutorials/recipes/running-tracetest-with-jaeger.mdx +++ b/docs/docs/examples-tutorials/recipes/running-tracetest-with-jaeger.mdx @@ -33,7 +33,7 @@ This is a simple quick start on how to configure a Node.js app to use OpenTeleme **Tracetest Account**: -- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/installation) docs. +- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/overview) docs. - Have access to the environment's [agent API key](https://app.tracetest.io/retrieve-token). **Docker**: Have [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/) installed on your machine. @@ -60,7 +60,7 @@ Follow along with the sections below for an in detail breakdown of what the exam ## Project Structure -The project contains [Tracetest Agent](/getting-started/installation#install-the-tracetest-agent), [OpenTelemetry Collector](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main), and a Node.js app. +The project contains [Tracetest Agent](/getting-started/install-agent), [OpenTelemetry Collector](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main), and a Node.js app. The `docker-compose.yaml` file in the root directory of the quick start runs the Node.js app and the [Tracetest Agent](/concepts/agent) setup. diff --git a/docs/docs/examples-tutorials/recipes/running-tracetest-with-lightstep.mdx b/docs/docs/examples-tutorials/recipes/running-tracetest-with-lightstep.mdx index eea18d3587..3e3be027bb 100644 --- a/docs/docs/examples-tutorials/recipes/running-tracetest-with-lightstep.mdx +++ b/docs/docs/examples-tutorials/recipes/running-tracetest-with-lightstep.mdx @@ -28,7 +28,7 @@ This is a simple sample app on how to configure the [OpenTelemetry Demo `v0.3.4- **Tracetest Account**: -- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/installation) docs. +- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/overview) docs. - Have access to the environment's [agent API key](https://app.tracetest.io/retrieve-token). **Docker**: Have [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/) installed on your machine. diff --git a/docs/docs/examples-tutorials/recipes/running-tracetest-with-new-relic.mdx b/docs/docs/examples-tutorials/recipes/running-tracetest-with-new-relic.mdx index 3933183635..59190b39b6 100644 --- a/docs/docs/examples-tutorials/recipes/running-tracetest-with-new-relic.mdx +++ b/docs/docs/examples-tutorials/recipes/running-tracetest-with-new-relic.mdx @@ -28,7 +28,7 @@ This is a simple sample app on how to configure the [OpenTelemetry Demo `v0.3.4- **Tracetest Account**: -- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/installation) docs. +- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/overview) docs. - Have access to the environment's [agent API key](https://app.tracetest.io/retrieve-token). **Docker**: Have [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/) installed on your machine. diff --git a/docs/docs/examples-tutorials/recipes/running-tracetest-with-opensearch.mdx b/docs/docs/examples-tutorials/recipes/running-tracetest-with-opensearch.mdx index 00e066a793..0dffe13640 100644 --- a/docs/docs/examples-tutorials/recipes/running-tracetest-with-opensearch.mdx +++ b/docs/docs/examples-tutorials/recipes/running-tracetest-with-opensearch.mdx @@ -33,7 +33,7 @@ This is a simple quick start on how to configure a Node.js app to use OpenTeleme **Tracetest Account**: -- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/installation) docs. +- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/overview) docs. - Have access to the environment's [agent API key](https://app.tracetest.io/retrieve-token). **Docker**: Have [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/) installed on your machine. @@ -60,7 +60,7 @@ Follow along with the sections below for an in detail breakdown of what the exam ## Project Structure -The project contains [Tracetest Agent](/getting-started/installation#install-the-tracetest-agent), [OpenSearch](https://github.com/opensearch-project/OpenSearch), [Data Prepper](https://github.com/opensearch-project/data-prepper), [OpenTelemetry Collector](https://github.com/open-telemetry/opentelemetry-collector-contrib), and a Node.js app. +The project contains [Tracetest Agent](/getting-started/install-agent), [OpenSearch](https://github.com/opensearch-project/OpenSearch), [Data Prepper](https://github.com/opensearch-project/data-prepper), [OpenTelemetry Collector](https://github.com/open-telemetry/opentelemetry-collector-contrib), and a Node.js app. The `docker-compose.yaml` file in the root directory of the quick start runs the Node.js app, OpenSearch, Data Prepper, OpenTelemetry Collector, and the [Tracetest Agent](/concepts/agent). diff --git a/docs/docs/examples-tutorials/recipes/running-tracetest-with-signoz-pokeshop.mdx b/docs/docs/examples-tutorials/recipes/running-tracetest-with-signoz-pokeshop.mdx index 4003d835ea..c63a7d3765 100644 --- a/docs/docs/examples-tutorials/recipes/running-tracetest-with-signoz-pokeshop.mdx +++ b/docs/docs/examples-tutorials/recipes/running-tracetest-with-signoz-pokeshop.mdx @@ -35,7 +35,7 @@ This is a simple quick start guide on how to configure a fully instrumented API **Tracetest Account**: -- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/installation) docs. +- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/overview) docs. - Have access to the environment's [agent API key](https://app.tracetest.io/retrieve-token). **Docker**: Have [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/) installed on your machine. @@ -62,7 +62,7 @@ Follow along with the sections below for an in detail breakdown of what the exam ## Project Structure -The project contains the [Tracetest Agent](/getting-started/installation#install-the-tracetest-agent), and the [Pokeshop Demo app](/live-examples/pokeshop/overview). +The project contains the [Tracetest Agent](/getting-started/install-agent), and the [Pokeshop Demo app](/live-examples/pokeshop/overview). The `docker-compose.agent.yaml` file in the root directory of the quick start runs the Pokeshop Demo app, [SigNoz](https://github.com/SigNoz/signoz), and the [Tracetest Agent](/concepts/agent) setup. diff --git a/docs/docs/examples-tutorials/recipes/running-tracetest-with-sumologic.mdx b/docs/docs/examples-tutorials/recipes/running-tracetest-with-sumologic.mdx index 7de3bd9783..cff34d55e0 100644 --- a/docs/docs/examples-tutorials/recipes/running-tracetest-with-sumologic.mdx +++ b/docs/docs/examples-tutorials/recipes/running-tracetest-with-sumologic.mdx @@ -34,7 +34,7 @@ This is a simple quick start on how to configure a Node.js app to use OpenTeleme **Tracetest Account**: -- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/installation) docs. +- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/overview) docs. - Have access to the environment's [agent API key](https://app.tracetest.io/retrieve-token). **Sumo Logic Account**: @@ -69,7 +69,7 @@ Follow along with the sections below for an in detail breakdown of what the exam ## Project Structure -The project contains [Tracetest Agent](/getting-started/installation#install-the-tracetest-agent), [OpenTelemetry Collector](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main), and a Node.js app. +The project contains [Tracetest Agent](/getting-started/install-agent), [OpenTelemetry Collector](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main), and a Node.js app. The [`docker-compose.yaml` file](https://github.com/kubeshop/tracetest/blob/main/examples/quick-start-sumologic-nodejs/docker-compose.yaml) in the root directory of the quick start runs the Node.js app and the [Tracetest Agent](/concepts/agent) setup. diff --git a/docs/docs/examples-tutorials/recipes/running-tracetest-with-tempo.mdx b/docs/docs/examples-tutorials/recipes/running-tracetest-with-tempo.mdx index 54075e76c9..d05716f365 100644 --- a/docs/docs/examples-tutorials/recipes/running-tracetest-with-tempo.mdx +++ b/docs/docs/examples-tutorials/recipes/running-tracetest-with-tempo.mdx @@ -33,7 +33,7 @@ This is a simple quick start on how to configure a Node.js app to use OpenTeleme **Tracetest Account**: -- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/installation) docs. +- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/overview) docs. - Have access to the environment's [agent API key](https://app.tracetest.io/retrieve-token). **Docker**: Have [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/) installed on your machine. @@ -60,7 +60,7 @@ Follow along with the sections below for an in detail breakdown of what the exam ## Project Structure -The project contains [Tracetest Agent](/getting-started/installation#install-the-tracetest-agent), [OpenTelemetry Collector](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main), and a Node.js app. +The project contains [Tracetest Agent](/getting-started/install-agent), [OpenTelemetry Collector](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main), and a Node.js app. The `docker-compose.yaml` file in the root directory of the quick start runs the Node.js app and the [Tracetest Agent](/concepts/agent) setup. diff --git a/docs/docs/examples-tutorials/recipes/running-tracetest-without-a-trace-data-store-with-manual-instrumentation.mdx b/docs/docs/examples-tutorials/recipes/running-tracetest-without-a-trace-data-store-with-manual-instrumentation.mdx index 632ba06c92..6e1a2cfe9a 100644 --- a/docs/docs/examples-tutorials/recipes/running-tracetest-without-a-trace-data-store-with-manual-instrumentation.mdx +++ b/docs/docs/examples-tutorials/recipes/running-tracetest-without-a-trace-data-store-with-manual-instrumentation.mdx @@ -31,7 +31,7 @@ This is a simple quick start on how to configure a Node.js app to use OpenTeleme **Tracetest Account**: -- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/installation) docs. +- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/overview) docs. - Have access to the environment's [agent API key](https://app.tracetest.io/retrieve-token). **Docker**: Have [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/) installed on your machine. diff --git a/docs/docs/examples-tutorials/recipes/running-tracetest-without-a-trace-data-store.mdx b/docs/docs/examples-tutorials/recipes/running-tracetest-without-a-trace-data-store.mdx index 52981de1e8..a17f794be5 100644 --- a/docs/docs/examples-tutorials/recipes/running-tracetest-without-a-trace-data-store.mdx +++ b/docs/docs/examples-tutorials/recipes/running-tracetest-without-a-trace-data-store.mdx @@ -31,7 +31,7 @@ This is a quick start on how to configure a Node.js app to use OpenTelemetry ins **Tracetest Account**: -- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/installation) docs. +- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/overview) docs. - Have access to the environment's [agent API key](https://app.tracetest.io/retrieve-token). **Docker**: Have [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/) installed on your machine. diff --git a/docs/docs/examples-tutorials/recipes/synthetic-monitoring-trace-based-api-tests.mdx b/docs/docs/examples-tutorials/recipes/synthetic-monitoring-trace-based-api-tests.mdx index 08c9fedb35..33d40a210b 100644 --- a/docs/docs/examples-tutorials/recipes/synthetic-monitoring-trace-based-api-tests.mdx +++ b/docs/docs/examples-tutorials/recipes/synthetic-monitoring-trace-based-api-tests.mdx @@ -35,7 +35,7 @@ To view the full guide on how to configure the Node.js app, view [this recipe](/ **Tracetest Account**: -- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/installation) docs. +- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/overview) docs. - Have access to the environment's [agent API key](https://app.tracetest.io/retrieve-token). **Docker**: Have [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/) installed on your machine. diff --git a/docs/docs/examples-tutorials/recipes/synthetic-monitoring-trace-based-playwright-tests.mdx b/docs/docs/examples-tutorials/recipes/synthetic-monitoring-trace-based-playwright-tests.mdx index 404b6f0e54..05d3b46fd7 100644 --- a/docs/docs/examples-tutorials/recipes/synthetic-monitoring-trace-based-playwright-tests.mdx +++ b/docs/docs/examples-tutorials/recipes/synthetic-monitoring-trace-based-playwright-tests.mdx @@ -47,7 +47,7 @@ Benefits of using traces as test specs alongside synthetic monitoring: **Tracetest Account**: -- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/installation) docs. +- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/overview) docs. - Have access to the environment's [agent API key](https://app.tracetest.io/retrieve-token). **Docker**: Have [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/) installed on your machine. diff --git a/docs/docs/examples-tutorials/recipes/testing-cloudflare-workers-with-opentelemetry-tracetest.mdx b/docs/docs/examples-tutorials/recipes/testing-cloudflare-workers-with-opentelemetry-tracetest.mdx index c94ca89c35..395acaa1f9 100644 --- a/docs/docs/examples-tutorials/recipes/testing-cloudflare-workers-with-opentelemetry-tracetest.mdx +++ b/docs/docs/examples-tutorials/recipes/testing-cloudflare-workers-with-opentelemetry-tracetest.mdx @@ -53,7 +53,7 @@ The Cloudflare Worker will fetch data from an external API, transform the data a ### Tracetest Account -- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/installation) docs. +- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/overview) docs. - Create an [environment](/concepts/environments). - Create an [environment token](/concepts/environment-tokens). - Have access to the environment's [agent API key](/configuration/agent). @@ -314,7 +314,7 @@ This starts the worker on `http://localhost:8787/` and it will listen for `POST` ## Testing the Cloudflare Worker Locally -[Download the CLI](/getting-started/installation#install-the-tracetest-cli) for your operating system. +[Download the CLI](/getting-started/install-cli) for your operating system. The CLI is bundled with [Tracetest Agent](/concepts/agent/) that runs in your infrastructure to collect responses and traces for tests. diff --git a/docs/docs/examples-tutorials/recipes/testing-distributed-services-with-tyk-opentelemetry-tracetest.mdx b/docs/docs/examples-tutorials/recipes/testing-distributed-services-with-tyk-opentelemetry-tracetest.mdx index bd1a6b7fd7..44152354da 100644 --- a/docs/docs/examples-tutorials/recipes/testing-distributed-services-with-tyk-opentelemetry-tracetest.mdx +++ b/docs/docs/examples-tutorials/recipes/testing-distributed-services-with-tyk-opentelemetry-tracetest.mdx @@ -50,7 +50,7 @@ cd tracetest/examples/quick-start-tyk **Tracetest Account**: -- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/installation) docs. +- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/overview) docs. - Have access to the environment's [agent API key](https://app.tracetest.io/retrieve-token). **Docker**: Have [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/) installed on your machine. diff --git a/docs/docs/examples-tutorials/recipes/testing-kafka-go-api-with-opentelemetry-tracetest.mdx b/docs/docs/examples-tutorials/recipes/testing-kafka-go-api-with-opentelemetry-tracetest.mdx index ca9a4af8bb..d3e6e706f2 100644 --- a/docs/docs/examples-tutorials/recipes/testing-kafka-go-api-with-opentelemetry-tracetest.mdx +++ b/docs/docs/examples-tutorials/recipes/testing-kafka-go-api-with-opentelemetry-tracetest.mdx @@ -34,7 +34,7 @@ This is a simple quick start on how to configure two Go APIs to communicate via **Tracetest Account**: -- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/installation) docs. +- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/overview) docs. - Have access to the environment's [agent API key](https://app.tracetest.io/retrieve-token). **Docker**: Have [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/) installed on your machine. diff --git a/docs/docs/examples-tutorials/recipes/testing-vercel-functions-with-opentelemetry-tracetest.mdx b/docs/docs/examples-tutorials/recipes/testing-vercel-functions-with-opentelemetry-tracetest.mdx index ccdbff4e98..58612f4d67 100644 --- a/docs/docs/examples-tutorials/recipes/testing-vercel-functions-with-opentelemetry-tracetest.mdx +++ b/docs/docs/examples-tutorials/recipes/testing-vercel-functions-with-opentelemetry-tracetest.mdx @@ -45,7 +45,7 @@ The Vercel function will fetch data from an external API, transform the data and **Tracetest Account**: -- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/installation) docs. +- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/overview) docs. - Create an [environment](/concepts/environments). - Create an [environment token](/concepts/environment-tokens). - Have access to the environment's [agent API key](/configuration/agent). @@ -212,7 +212,7 @@ This starts the function on `http://localhost:3000/api/pokemon`. ## Testing the Vercel Function Locally -[Download the CLI](/getting-started/installation#install-the-tracetest-cli) for your operating system. +[Download the CLI](/getting-started/install-cli) for your operating system. The CLI is bundled with [Tracetest Agent](/concepts/agent/) that runs in your infrastructure to collect responses and traces for tests. diff --git a/docs/docs/getting-started/automate-test-runs.mdx b/docs/docs/getting-started/automate-test-runs.mdx new file mode 100644 index 0000000000..91eee3bdb8 --- /dev/null +++ b/docs/docs/getting-started/automate-test-runs.mdx @@ -0,0 +1,100 @@ +--- +id: automate-test-runs +title: Automate Test Runs +description: Get started with automating test runs with synthetic monitors. Tracetest allows you to quickly build integration and end-to-end tests, powered by your OpenTelemetry traces. +hide_table_of_contents: false +keywords: + - tracetest + - trace-based testing + - observability + - distributed tracing + - testing +image: https://res.cloudinary.com/djwdcmwdz/image/upload/v1698686403/docs/Blog_Thumbnail_14_rsvkmo.jpg +--- + +You know how to: + +- Create and run a test. +- Generate a trace for every test. +- Create assertions. + +The only thing left is to automate test runs. You can do this: + +- [Natively with Synthetic Monitors](/concepts/monitors) +- [With CI/CD Integrations](/ci-cd-automation/overview) +- [With SDKs](/tools-and-integrations/typescript) +- [With Test Tool Integrations](/tools-and-integrations/overview) + +## Automate Test Runs with Synthetic Monitors + +This guide explains how to create a Synthetic Monitor that triggers a test every 5 minutes. + +A Synthetic Monitor consists of: + +- Name +- Enabled flag (`true`/`false`) +- List of tests +- Schedule (cronjob syntax) +- List of alerts + +## List of Tests + +You can define any number of tests to run on a schedule as part of a Synthetic Monitor. + +## Schedule + +Use a CronJob syntax or the Web UI dropdown to configure the schedule when the Synthetic Monitor will run. + +## List of Alerts + +You can define any number of webhooks to send alerts to. This enables integrating with your favorite alerting tools. + +## Create Synthetic Monitors in Two Ways + +1. Programmatically, in YAML +2. Visually, in the Web UI + +## Create Synthetic Monitors Programatically in YAML + +Using the test you added assertions to in the previous section, you can reference it in the resource definition for a Synthetic Monitor. + +```yaml +type: Monitor +spec: + name: Import Pokemon Monitor + enabled: true + tests: + - ./import-pokemon.yaml + schedule: + cron: "*/5 * * * *" + alerts: + - id: slack-webhook-message + type: webhook + webhook: + body: "{\n \"text\": \"Monitor ${.Monitor.Name} has failed, follow the link to find the <${.URL}|results>\"\n}" + method: POST + url: + headers: + - key: Content-Type + value: application/json + events: + - FAILED +``` + +### The Synthetic Monitor You Defined + +1. Runs the `import-pokemon.yaml` test. +2. Has a schedule of every 5 minutes. +3. Sends a webhook alert to Slack when the test fails. + +## Create Synthetic Monitors Visually with the Web UI + +Add Synthetic Monitors quickly by using the Web UI. + +![create monitor 1](https://res.cloudinary.com/djwdcmwdz/image/upload/v1727285755/docs/app.tracetest.io_organizations_ttorg_e66318ba6544b856_environments_ttenv_ed85b0979257d37b_monitor_jCqz9yRNg_run_2_j8zqdb.png) + +## Why Tracetest Synthetic Monitors are Powerful + +1. You wrote **ZERO** lines of programming code. It's all defined in YAML. +2. You can save them as part of your GitHub repo because it's defined in YAML. +3. You do **NOT** need to use external CI tools to automate running tests. diff --git a/docs/docs/getting-started/configure-trace-ingestion.mdx b/docs/docs/getting-started/configure-trace-ingestion.mdx new file mode 100644 index 0000000000..ee7674ac1e --- /dev/null +++ b/docs/docs/getting-started/configure-trace-ingestion.mdx @@ -0,0 +1,147 @@ +--- +id: configure-trace-ingestion +title: Configure Trace Ingestion +description: Get started by configuring trace ingestion to connect traces to tests. Tracetest allows you to quickly build integration and end-to-end tests, powered by your OpenTelemetry traces. +hide_table_of_contents: false +keywords: + - tracetest + - trace-based testing + - observability + - distributed tracing + - testing + - trace ingestion + - trace testing + - ingest traces +image: https://res.cloudinary.com/djwdcmwdz/image/upload/v1698686403/docs/Blog_Thumbnail_14_rsvkmo.jpg +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import CodeBlock from '@theme/CodeBlock'; +import GtagInstallCliTabs from '@site/src/components/GtagInstallCliTabs'; + +[Tracetest Agent](/concepts/agent) runs alongside your apps, in the same environment/network, to do two things: + +1. Run tests against your apps. +2. Ingest traces from your apps. + +This page explains (2), how to ingest traces into Tracetest Agent to enable trace-based testing. + +## Enable Trace Ingestion with an OTLP Endpoint + +Create a file called `trace-ingestion.yaml`. + +```yaml title="trace-ingestion.yaml" +type: DataStore +spec: + name: Opentelemetry Collector pipeline + type: otlp + default: true +``` + +And, run it with the CLI. + +```bash title="Terminal" +tracetest apply datastore -f ./trace-ingestion.yaml +``` + +Or, use the Web UI. Go to Settings > Trace Ingestion, and toggle "Enable Trace Ingestion" to on. + +![trace ingestion 1](https://res.cloudinary.com/djwdcmwdz/image/upload/v1727178199/docs/app.tracetest.io_organizations_ttorg_e66318ba6544b856_environments_ttenv_ed85b0979257d37b_tests_page_1_3_l0v8wp.png) + +Select OpenTelemetry. + +![trace ingestion 2](https://res.cloudinary.com/djwdcmwdz/image/upload/v1727178201/docs/app.tracetest.io_organizations_ttorg_e66318ba6544b856_environments_ttenv_ed85b0979257d37b_tests_page_1_4_fyhu3d.png) + +## Configure Trace Exporters to Send Traces to Tracetest Agent + +Once configured, Tracetest Agent exposes OTLP ports `4317` (gRPC) and `4318` (HTTP) for trace ingestion. Configure your trace exporters to send traces to the Tracetest Agent OTLP endpoint. + + + + +With the Tracetest Agent running locally, the trace ingestion OTLP endpoints will be: + +- gRPC: `http://localhost:4317` +- HTTP: `http://localhost:4318/v1/traces` + + + + +With the Tracetest Agent running in Docker with `tracetest-agent` as the service name, the trace ingestion OTLP endpoints will be: + +- gRPC: `http://tracetest-agent:4317` +- HTTP: `http://tracetest-agent:4318/v1/traces` + +:::note Docker Network +Running a test against `localhost` will resolve as `127.0.0.1` inside the Tracetest Agent container. + +Add Tracetest Agent to the same network and use service name mapping. *Example: Instead of running an app on `localhost:8080`, add it to your Docker Compose file, connect it to the same network as your Tracetest Agent service, and use `:8080` in the URL field when creating a test.* + +You can reach services running on your local machine using: + +- Linux (docker version < 20.10.0): `172.17.0.1:8080` +- MacOS (docker version >= 18.03) and Linux (docker version >= 20.10.0): `host.docker.internal:8080` +::: + + + + +With the Tracetest Agent running in Docker with `tracetest-agent` as the service name, the trace ingestion OTLP endpoints will be: + +- gRPC: `http://tracetest-agent:4317` +- HTTP: `http://tracetest-agent:4318/v1/traces` + +:::note Docker Network +Running a test against `localhost` will resolve as `127.0.0.1` inside the Tracetest Agent container. + +Add Tracetest Agent to the same network and use service name mapping. *Example: Instead of running an app on `localhost:8080`, add it to your Docker Compose file, connect it to the same network as your Tracetest Agent service, and use `:8080` in the URL field when creating a test.* + +You can reach services running on your local machine using: + +- Linux (Docker version < 20.10.0): `172.17.0.1:8080` +- MacOS (Docker version >= 18.03) and Linux (Docker version >= 20.10.0): `host.docker.internal:8080` +::: + + + + +With the Tracetest Agent running in Kubernetes with `tracetest-agent` as the service name, the trace ingestion OTLP endpoints will be: + +- gRPC: `http://tracetest-agent.default.svc.cluster.local:4317` +- HTTP: `http://tracetest-agent.default.svc.cluster.local:4318/v1/traces` + +:::note K8s Network +Make sure to use the correct `` if you edit the Tracetest Agent `service` name. + +Running a test against `localhost` will resolve as `127.0.0.1` inside the Tracetest Agent container. +Make sure to run tests using the internal Kubernetes service networking eg: `http://.default.svc.cluster.local:port`. +::: + + + + +With the Tracetest Agent running in Kubernetes with `agent` as the Helm ``, the trace ingestion OTLP endpoints will be: + +- gRPC: `http://agent-tracetest-agent:4317` +- HTTP: `http://agent-tracetest-agent:4318/v1/traces` + +:::note K8s Network +Make sure to use the correct `` if you edit the Tracetest Agent Helm chart `` name. + +Running a test against `localhost` will resolve as `127.0.0.1` inside the Tracetest Agent container. +Make sure to run tests using the internal Kubernetes service networking eg: `http://.default.svc.cluster.local:port`. + +In the following example you can use: `http://pokeshop-pokemon-api:8081`. +::: + + + + +:::note Need more detailed guidance? +[Refer to the Trace Ingestion docs, here.](/configuration/connecting-to-data-stores/overview) +::: + +:::tip Don't have OpenTelemetry installed? +[Follow these instructions to install OpenTelemetry in 5 minutes without any code changes!](./no-otel.mdx) +::: diff --git a/docs/docs/getting-started/create-assertions.mdx b/docs/docs/getting-started/create-assertions.mdx new file mode 100644 index 0000000000..85795d1546 --- /dev/null +++ b/docs/docs/getting-started/create-assertions.mdx @@ -0,0 +1,259 @@ +--- +id: create-assertions +title: Create Assertions +description: Get started with creating test specs and assertions based on traces. Tracetest allows you to quickly build integration and end-to-end tests, powered by your OpenTelemetry traces. +hide_table_of_contents: false +keywords: + - tracetest + - trace-based testing + - observability + - distributed tracing + - testing +image: https://res.cloudinary.com/djwdcmwdz/image/upload/v1698686403/docs/Blog_Thumbnail_14_rsvkmo.jpg +--- + +Now you know how to generate a trace for every test. This page explains how to create assertions by using real trace data from your distributed trace spans. Assertions are the most crucial part of a test. They allow you to validate that your system behaves as expected. + +An assertion consists of: + +- Selector +- List of assertions +- Name (Optional) + +```yaml +- selector: span[tracetest.span.type="http" name="POST /pokemon/import" http.method="POST"] + name: POST /pokemon/import was called successfuly + assertions: + - attr:http.status_code = 200 + - attr:http.response.body | json_path '$.id' = "143" +``` + +![create assertions 1](https://res.cloudinary.com/djwdcmwdz/image/upload/v1727255867/docs/app.tracetest.io_organizations_ttorg_e66318ba6544b856_environments_ttenv_ed85b0979257d37b_test_UNLBkLgHR_run_5_trace_1_lnyulp.png) + +## Selector + +The selector defines against which spans assertions will be executed. Selectors can match any number of spans—zero, one, twenty, or an unknown number. + +## Assertions + +Assertions are the validations you define. Here are some examples: + +- Verify that the HTTP response code of the trigger was 200. +- Parse the response JSON and confirm that the returned object has a non-empty ID field. +- Use JSON path on the response body to get specific fields, validate list length, perform regex matches, etc. +- Check response times. + +The biggest value comes from analysing the trace itself. For instance: + +- Ensure that any database query took less than 100ms. +- Verify if a specific service was called, and even validate how many times it was invoked. +- Examine spans generated by an asynchronous process after the request passes through a message queue like Kafka, RabbitMQ, etc. +- Validate external asynchronous HTTP requests. + +## Create Assertions in Two Ways + +1. Programmatically, in YAML +2. Visually, in the Web UI + +## Create Assertions Programatically in YAML + +Taking the test you ran in the previous section, you can add assertions with a `specs` block. + +```yaml +type: Test +spec: + name: Import a Pokemon using API and MQ Worker + description: Import a Pokemon + # Define the trigger + trigger: + type: http + httpRequest: + method: POST + # Define the app endpoint + url: ${var:POKESHOP_API_URL}/pokemon/import + body: | + { + "id": 143 + } + headers: + - key: Content-Type + value: application/json + + # Define the assertions to be applied against the resulting trace + specs: + - selector: span[tracetest.span.type="http" name="POST /pokemon/import" http.method="POST"] + name: POST /pokemon/import was called successfuly + assertions: + - attr:http.status_code = 200 + - attr:http.response.body | json_path '$.id' = "143" + + - selector: span[tracetest.span.type="general" name="validate request"] + name: The request was validated correctly + assertions: + - attr:validation.is_valid = "true" + + - selector: span[tracetest.span.type="messaging" name="queue.synchronizePokemon publish"] + name: A message was enqueued to the worker + assertions: + - attr:messaging.payload | json_path '$.id' = "143" + + - selector: span[tracetest.span.type="messaging" name="queue.synchronizePokemon process"] + name: A message was read by the worker + assertions: + - attr:messaging.payload | json_path '$.fields.routingKey' = "queue.synchronizePokemon" + + - selector: span[tracetest.span.type="general" name="import pokemon"] + name: A "import pokemon" action was triggered + assertions: + - attr:tracetest.selected_spans.count >= 1 + + - selector: span[tracetest.span.type="database"] + name: All Database Spans Processing time is less than 500ms + assertions: + - attr:tracetest.span.duration < 500ms + + - selector: span[tracetest.span.type="database" name="create pokeshop.pokemon"] + name: Validate exactly 1 database create operation was executed + assertions: + - attr:db.operation = "create" + - attr:tracetest.selected_spans.count = 1 + + - selector: span[tracetest.span.type="database" name="get pokemon_143"] + name: Validate the cache was not hit. + assertions: + - attr:cache.hit = "false" + + - selector: span[tracetest.span.type="database" name="delete pokeshop.pokemon"] + name: Validate that no database DELETE operation was made + assertions: + - attr:tracetest.selected_spans.count = 0 +``` + +### The Assertions You Defined + +1. Validating the response of the HTTP request by validating both the response status code and the response body. +2. Validate the attribute `is_valid` is set to `true` in a custom span called `validate request`. +3. Validate a **message** with an `id` of `143` was **added to a message queue**. +4. Validate a **message** with a `routingKey` of `queue.synchronizePokemon` was **read by a message queue**. +5. Validate a span called `import pokemon` exists - **Validate an action happened**. +6. Validate that **all the involved database operations** took less than `500ms`. +7. Validate that there was exactly one database `create` operation, that the cache was not hit, and that there were zero `delete` operations. + +## Create Assertions Visually with the Web UI + +Add assertions quickly by using the assertion snippets, or selecting a span attribute and clicking `Create test spec`. + +![add assertion visually 1](https://res.cloudinary.com/djwdcmwdz/image/upload/v1727259954/docs/Screenshot_2024-09-25_at_12.25.37_g2nwhw.png) + +This opens the assertions engine. + +1. Validating the response of the HTTP request by validating both the response status code and the response body. + +![add assertions visuall 2](https://res.cloudinary.com/djwdcmwdz/image/upload/v1727255867/docs/app.tracetest.io_organizations_ttorg_e66318ba6544b856_environments_ttenv_ed85b0979257d37b_test_UNLBkLgHR_run_5_trace_1_lnyulp.png) + +2. Validate the attribute `is_valid` is set to `true` in a custom span called `validate request`. + +![add assertions visually 3](https://res.cloudinary.com/djwdcmwdz/image/upload/v1727260254/docs/app.tracetest.io_organizations_ttorg_e66318ba6544b856_environments_ttenv_ed85b0979257d37b_test_fVPPePgHR_run_3_test_selectedSpan_91e7ec4663f2ce43_rewmb7.png) + +3. Validate a **message** with an `id` of `143` was **added to a message queue**. + +![add assertions visually 4](https://res.cloudinary.com/djwdcmwdz/image/upload/v1727260595/docs/app.tracetest.io_organizations_ttorg_e66318ba6544b856_environments_ttenv_ed85b0979257d37b_test_fVPPePgHR_run_3_test_selectedSpan_91e7ec4663f2ce43_1_pleufw.png) + +4. Validate a **message** with a `routingKey` of `queue.synchronizePokemon` was **read by a message queue**. + +![add assertions visually 5](https://res.cloudinary.com/djwdcmwdz/image/upload/v1727260916/docs/app.tracetest.io_organizations_ttorg_e66318ba6544b856_environments_ttenv_ed85b0979257d37b_test_fVPPePgHR_run_3_test_selectedSpan_91e7ec4663f2ce43_4_fz87wo.png) + +5. Validate a span called `import pokemon` exists - **Validate an action happened**. + +![add assertions visually 6](https://res.cloudinary.com/djwdcmwdz/image/upload/v1727260917/docs/app.tracetest.io_organizations_ttorg_e66318ba6544b856_environments_ttenv_ed85b0979257d37b_test_fVPPePgHR_run_3_test_selectedSpan_91e7ec4663f2ce43_5_gvf5u5.png) + +6. Validate that **all the involved database operations** took less than `500ms`. + +![add assertions visually 7](https://res.cloudinary.com/djwdcmwdz/image/upload/v1727260917/docs/app.tracetest.io_organizations_ttorg_e66318ba6544b856_environments_ttenv_ed85b0979257d37b_test_fVPPePgHR_run_3_test_selectedSpan_91e7ec4663f2ce43_6_cv7v8y.png) + +7. Validate that there was exactly one database `create` operation, that the cache was not hit, and that there were zero `delete` operations. + +![add assertions visually 8](https://res.cloudinary.com/djwdcmwdz/image/upload/v1727260918/docs/app.tracetest.io_organizations_ttorg_e66318ba6544b856_environments_ttenv_ed85b0979257d37b_test_fVPPePgHR_run_3_test_selectedSpan_91e7ec4663f2ce43_7_hbi4xl.png) + +![add assertions visually 9](https://res.cloudinary.com/djwdcmwdz/image/upload/v1727260918/docs/app.tracetest.io_organizations_ttorg_e66318ba6544b856_environments_ttenv_ed85b0979257d37b_test_fVPPePgHR_run_3_test_selectedSpan_91e7ec4663f2ce43_8_s46uzd.png) + +## Why Tracetest Assertions are Powerful + +1. You wrote **ZERO** lines of programming code. It's all defined in YAML. +2. You can save them as part of your GitHub repo because it's defined in YAML. +3. Tracetest has **NO** access to your database, logs, or any other confidential infrastructure information. Assertions only validate the distributed traces your apps export. +4. Tracetest **DOES NOT** care about how many services were called internally, or which languages your services are written in, or what database you're using. Tracetest **only cares about the distributed trace data** you expose to use as assertions. +5. Tracetest can validate that things that **DID** or **DID NOT** happen, with just 3 lines of YAML! + +## How Do Selectors Work? + +**Selectors** works in a similar way as CSS selectors. You can select spans by matching their attributes. Attributes can be generic, like span type, duration, or be defined by your apps. + +Here are some examples: + +```yaml +# all database spans +- selector: span[tracetest.span.type="database"] + +# all http serving spans +- selector: span[tracetest.span.type="http"] + +# all spans that have the custom defined attribute of myapp.user_id +- selector: span[myapp.user_id="123"] + +# all spans that have the custom defined attribute of myapp.user_id that are database operations +- selector: span[tracetest.span.type="database" myapp.user_id="123"] + +# all spans that have the custom defined attribute of myapp.user_id that are database operations that are children of the user service +- selector: span[service.name="myapp-user-service"] span[tracetest.span.type="database" myapp.user_id="123"] +``` + +Check the full [selector docs, here](/concepts/selectors). + +## How Do Assertions Work? + +Assertions are the checks you can apply to the values of all the spans matched by the related selector. + +Here are some examples: + +```yaml +# validate that all spans from myapp-user-service have a non empty user_id attribute +- selector: span[service.name="myapp-user-service"] + assertions: + - attr:myapp.user_id != "" + +- selector: span[tracetest.span.type="http" name="GET /pokemon?take=10&skip=0" http.method="GET"] + assertions: + - attr:http.status_code = 200 + - attr:tracetest.response.body | json_path '$.items' | length <= 10 +``` + +Check the full [assertions docs, here](/concepts/assertions). + +## How Do Expressions Work? + +Tracetest allows you to add expressions when writing test specs. + +### General Span Attributes + +- `tracetes.span.duration` +- `tracetest.response.body` +- and more. + +### Filters + +- `json_path` +- `lenght` +- `regex` +- `get_index` +- and more. + +### String Interpolation + +- `${}` + +Check the full [expressions docs, here](/concepts/expressions). + +:::tip Don't have OpenTelemetry installed? +[Follow these instructions to install OpenTelemetry in 5 minutes without any code changes!](./no-otel.mdx) +::: diff --git a/docs/docs/getting-started/create-response-based-test.mdx b/docs/docs/getting-started/create-response-based-test.mdx new file mode 100644 index 0000000000..2b1b1e805e --- /dev/null +++ b/docs/docs/getting-started/create-response-based-test.mdx @@ -0,0 +1,75 @@ +--- +id: create-response-based-test +title: Create a Response-based Test +description: Get started by creating a response-based test in Tracetest! Tracetest allows you to quickly build integration and end-to-end tests, powered by your OpenTelemetry traces. +hide_table_of_contents: false +keywords: + - tracetest + - trace-based testing + - observability + - distributed tracing + - testing + - create test + - create tracetest test + - run tracetest test + - execute tracetest test +image: https://res.cloudinary.com/djwdcmwdz/image/upload/v1698686403/docs/Blog_Thumbnail_14_rsvkmo.jpg +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import CodeBlock from '@theme/CodeBlock'; +import GtagInstallCliTabs from '@site/src/components/GtagInstallCliTabs'; + +To create a test, you define a `trigger`. A trigger is an action that executes an action against your system. The most basic trigger is an HTTP requests, but we support several trigger types. + +1. Playwright +2. HTTP +3. GRPC +4. GraphQL +5. Kafka + +:::note +Playwright enables a useful technique: True end-to-end testing, where you start tests from the Web UI and explore the entire internal process of that request across the back end, database, and external services. +::: + +You can create tests in two ways: + +1. Programmatically, in YAML +2. Visually, in the Web UI + +Once started, Tracetest Agent executes tests in the environment where it is running and returns the response from triggered tests. This is how you run basic response-based testing. + +## Create a Test Programatically in YAML + +Create a file called `ping-google.yaml`. + +```yaml title="ping-google.yaml" +type: Test +spec: + name: Ping Google + trigger: + type: http + httpRequest: + method: GET + url: https://google.com + headers: + - key: Content-Type + value: application/json +``` + +Run it with the CLI. + +```bash title="Terminal" +tracetest run test -f ./ping-google.yaml +``` + +## Create a Test Visually with the Web UI + +Create a test in the Web UI by opening your Tracetest Account, clicking the Create button, and selecting HTTP. + +![create response based test 1](https://res.cloudinary.com/djwdcmwdz/image/upload/v1727177155/docs/app.tracetest.io_organizations_ttorg_e66318ba6544b856_environments_ttenv_ed85b0979257d37b_tests_page_1_qc1291.png) + +Enter `https://google.com` as the URL, and click Run. + +![create response based test 2](https://res.cloudinary.com/djwdcmwdz/image/upload/v1727177429/docs/app.tracetest.io_organizations_ttorg_e66318ba6544b856_environments_ttenv_ed85b0979257d37b_tests_page_1_1_qpqa4w.png) \ No newline at end of file diff --git a/docs/docs/getting-started/create-trace-based-test.mdx b/docs/docs/getting-started/create-trace-based-test.mdx new file mode 100644 index 0000000000..061807e959 --- /dev/null +++ b/docs/docs/getting-started/create-trace-based-test.mdx @@ -0,0 +1,357 @@ +--- +id: create-trace-based-test +title: Create a Trace-based Test +description: Get started by installing Tracetest! Tracetest allows you to quickly build integration and end-to-end tests, powered by your OpenTelemetry traces. +hide_table_of_contents: false +keywords: + - tracetest + - trace-based testing + - observability + - distributed tracing + - testing +image: https://res.cloudinary.com/djwdcmwdz/image/upload/v1698686403/docs/Blog_Thumbnail_14_rsvkmo.jpg +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import CodeBlock from '@theme/CodeBlock'; +import GtagInstallCliTabs from '@site/src/components/GtagInstallCliTabs'; + +So far, you've learned: + +- How to define a trigger to executes tests against your apps. +- How to configure trace ingestion. +- How to configure your application to export traces. + +This will enable trace-based testing in your apps that have OpenTelemetry distributed tracing configured. + +We've provided a sample application with OpenTelemetry already enabled for you to try. + +## Start the Sample Pokeshop API + +To create tests quickly, start the official sample called [Pokeshop API](/live-examples/pokeshop/overview). + + + + +```bash title="Terminal" +git clone --depth 1 https://github.com/kubeshop/tracetest.git +cd tracetest/examples/tracetest-agent/pokeshop/ + +docker compose up -d --build +``` + +- [`https://app.tracetest.io/`](https://app.tracetest.io) - Access the Tracetest Web UI. Sign up and create an organization. +- [`http://localhost:8081`](http://localhost:8081) - The Pokeshop API demo is exposed from Docker to `localhost` on this port. +- `http://localhost:8081` - To run tests you will use `localhost` since it is exposed from Docker. +- `http://localhost:4317` - Trace ingestion URL where Tracetest Agent will accept traces. Since Pokeshop is running in Docker and Tracetest Agent is running on `localhost` this sample uses `http://host.docker.internal:4317` to ingest traces instead of `http://localhost:4317`. + + + + + +```bash title="Terminal" +git clone --depth 1 https://github.com/kubeshop/pokeshop.git +cd pokeshop + +docker compose up -d --build +``` + +- [`https://app.tracetest.io/`](https://app.tracetest.io) - Access the Tracetest Web UI. Sign up and create an organization. +- [`http://localhost:8081`](http://localhost:8081) - The Pokeshop API demo is exposed from Docker to `localhost` on this port. +- `http://api:8081` - To run tests you will use the Docker internal network and the Pokeshop app's service name. +- `http://tracetest-agent:4317` - Trace ingestion URL where Tracetest Agent will accept traces. + + + + + +```bash title="Terminal" +git clone --depth 1 https://github.com/kubeshop/pokeshop.git +cd pokeshop + +docker compose up -d --build +``` + +- [`https://app.tracetest.io/`](https://app.tracetest.io) - Access the Tracetest Web UI. Sign up and create an organization. +- [`http://localhost:8081`](http://localhost:8081) - The Pokeshop API demo is exposed from Docker to `localhost` on this port. +- `http://api:8081` - To run tests you will use the Docker internal network and the service name. +- `http://tracetest-agent:4317` - Trace ingestion URL where Tracetest Agent will accept traces. + + + + + +```bash title="Terminal" +git clone --depth 1 https://github.com/kubeshop/pokeshop.git +cd pokeshop/k8s + +kubectl apply -f . +``` + +To access the Pokeshop API run a `port-forward`: + +```bash +kubectl port-forward svc/api 8081:8081 +``` + +- [`https://app.tracetest.io/`](https://app.tracetest.io) - Access the Tracetest Web UI. Sign up and create an organization. +- [`http://localhost:8081`](http://localhost:8081) - The Pokeshop API demo is port forwarded from Kubernetes to `localhost` on this port. +- `http://api.default.svc.cluster.local:8081` - To run tests you will use the Kubernetes internal network and the service name. +- `http://tracetest-agent.default.svc.cluster.local:4317` - Trace ingestion URL where Tracetest Agent will accept traces. + + + + + +```bash title="Terminal" +git clone --depth 1 https://github.com/kubeshop/pokeshop.git +cd pokeshop/helm-charts + +helm dependency update +helm install -f values.yaml --create-namespace pokeshop . +``` + +To access the Pokeshop API run a `port-forward`: + +```bash +kubectl port-forward svc/pokeshop-pokemon-api 8081:8081 +``` + +- [`https://app.tracetest.io/`](https://app.tracetest.io) - Access the Tracetest Web UI. Sign up and create an organization. +- [`http://localhost:8081`](http://localhost:8081) - The Pokeshop API demo is port forwarded from Kubernetes to `localhost` on this port. +- `http://pokeshop-pokemon-api:8081` - To run tests you will use the Kubernetes internal network and the service name. +- `http://agent-tracetest-agent:4317` - Trace ingestion URL where Tracetest Agent will accept traces. + + + + + +
+ + Click to view the sample Pokeshop API architecture + + +Here's the Architecture of the Pokeshop Sample App: + +- an **API** that serves client requests, +- a **Worker** who deals with background processes. + +The communication between the API and Worker is made using a `RabbitMQ` queue, and both services emit telemetry data to OpenTelemetry Collector and communicate with a Postgres database. + +Tracetest triggers tests against the Node.js API. + +```mermaid +flowchart TD + A[(Redis)] + B[(Postgres)] + C(Node.js API) + D(RabbitMQ) + E(Worker) + F(OpenTelemetry Collector) + G(Tracetest) + + G --> C + F --> G + C --> A + C --> B + C --> D + D --> E + E --> B + C --> F + E --> F + + +``` +
+ +## Create Trace-based Tests in Two Ways + +1. Programmatically, in YAML +2. Visually, in the Web UI + +## Create a Trace-based Test Programatically in YAML + +Create a file called `import-pokemon.yaml`. + + + + +```yaml title="import-pokemon.yaml" +type: Test +spec: + name: Import a Pokemon using API and MQ Worker + description: Import a Pokemon + trigger: + type: http + httpRequest: + method: POST + url: http://localhost:8081/pokemon/import + body: | + { + "id": 143 + } + headers: + - key: Content-Type + value: application/json +``` + + + + + +```yaml title="import-pokemon.yaml" +type: Test +spec: + name: Import a Pokemon using API and MQ Worker + description: Import a Pokemon + trigger: + type: http + httpRequest: + method: POST + url: http://api:8081/pokemon/import + body: | + { + "id": 143 + } + headers: + - key: Content-Type + value: application/json +``` + + + + + +```yaml title="import-pokemon.yaml" +type: Test +spec: + name: Import a Pokemon using API and MQ Worker + description: Import a Pokemon + trigger: + type: http + httpRequest: + method: POST + url: http://api:8081/pokemon/import + body: | + { + "id": 143 + } + headers: + - key: Content-Type + value: application/json +``` + + + + + +```yaml title="import-pokemon.yaml" +type: Test +spec: + name: Import a Pokemon using API and MQ Worker + description: Import a Pokemon + trigger: + type: http + httpRequest: + method: POST + url: http://api.default.svc.cluster.local:8081/pokemon/import + body: | + { + "id": 143 + } + headers: + - key: Content-Type + value: application/json +``` + + + + + +```yaml title="import-pokemon.yaml" +type: Test +spec: + name: Import a Pokemon using API and MQ Worker + description: Import a Pokemon + trigger: + type: http + httpRequest: + method: POST + url: http://pokeshop-pokemon-api:8081/pokemon/import + body: | + { + "id": 143 + } + headers: + - key: Content-Type + value: application/json +``` + + + + + + +Run it with the CLI. + +```bash title="Terminal" +tracetest run test -f ./import-pokemon.yaml +``` + +## Create a Trace-based Test Visually with the Web UI + +Create a test in the Web UI by opening your Tracetest account, clicking the Create button, and selecting HTTP. + +![create trace based tests 1](https://res.cloudinary.com/djwdcmwdz/image/upload/v1727192707/docs/app.tracetest.io_organizations_ttorg_e66318ba6544b856_environments_ttenv_ed85b0979257d37b_tests_page_1_5_v178q5.png) + + + + +Enter `http://localhost:8081/pokemon/import` as the URL, select `POST`, add a JSON body `{ "id": 6 }`, and click Run. + +![create trace based test 2](https://res.cloudinary.com/djwdcmwdz/image/upload/v1727192710/docs/app.tracetest.io_organizations_ttorg_e66318ba6544b856_environments_ttenv_ed85b0979257d37b_tests_page_1_6_e8mq2b.png) + + + + +Enter `http://api:8081/pokemon/import` as the URL, select `POST`, add a JSON body `{ "id": 6 }`, and click Run. + +![create trace based test 2](https://res.cloudinary.com/djwdcmwdz/image/upload/v1727193718/docs/app.tracetest.io_organizations_ttorg_e66318ba6544b856_environments_ttenv_ed85b0979257d37b_tests_page_1_7_qduuga.png) + + + + + +Enter `http://api:8081/pokemon/import` as the URL, select `POST`, add a JSON body `{ "id": 6 }`, and click Run. + +![create trace based test 3](https://res.cloudinary.com/djwdcmwdz/image/upload/v1727193718/docs/app.tracetest.io_organizations_ttorg_e66318ba6544b856_environments_ttenv_ed85b0979257d37b_tests_page_1_7_qduuga.png) + + + + + +Enter `http://api.default.svc.cluster.local:8081/pokemon/import` as the URL, select `POST`, add a JSON body `{ "id": 6 }`, and click Run. + +![create trace based test 4](https://res.cloudinary.com/djwdcmwdz/image/upload/v1727253317/docs/app.tracetest.io_organizations_ttorg_e66318ba6544b856_environments_ttenv_ed85b0979257d37b_tests_page_1_8_hutudo.png) + + + + + +Enter `http://pokeshop-pokemon-api:8081/pokemon/import` as the URL, select `POST`, add a JSON body `{ "id": 6 }`, and click Run. + +![create trace based test 5](https://res.cloudinary.com/djwdcmwdz/image/upload/v1727253367/docs/app.tracetest.io_organizations_ttorg_e66318ba6544b856_environments_ttenv_ed85b0979257d37b_tests_page_1_9_kovmsf.png) + + + + +## View the Trace Response + +With trace ingestion configured you can view the resulting trace that was generated by the app. Every test you run will now have additional observability with distributed traces. + +![create trace based test 6](https://res.cloudinary.com/djwdcmwdz/image/upload/v1727254755/docs/app.tracetest.io_organizations_ttorg_e66318ba6544b856_environments_ttenv_ed85b0979257d37b_test_UNLBkLgHR_run_5_trace_qjmye0.png) + +:::tip Don't have OpenTelemetry installed? +[Follow these instructions to install OpenTelemetry in 5 minutes without any code changes!](./no-otel.mdx) +::: diff --git a/docs/docs/getting-started/create-tracetest-account.mdx b/docs/docs/getting-started/create-tracetest-account.mdx new file mode 100644 index 0000000000..66fe07d0d1 --- /dev/null +++ b/docs/docs/getting-started/create-tracetest-account.mdx @@ -0,0 +1,27 @@ +--- +id: create-tracetest-account +title: Create a Tracetest Account +description: Get started by signing up to Tracetest! Tracetest allows you to quickly build integration and end-to-end tests, powered by your OpenTelemetry traces. +hide_table_of_contents: true +keywords: + - tracetest + - trace-based testing + - observability + - distributed tracing + - testing + - tracetest cloud + - tracetest account +image: https://res.cloudinary.com/djwdcmwdz/image/upload/v1698686403/docs/Blog_Thumbnail_14_rsvkmo.jpg +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import GtagInstallCliTabs from '@site/src/components/GtagInstallCliTabs'; + +:::note +This getting started guide is a quick start with [Cloud-based Managed Tracetest](https://app.tracetest.io/). To use [Enterprise On-prem Tracetest, refer to this guide](/install/on-prem-helm). +::: + +1. [Sign into Cloud-based Managed Tracetest](https://app.tracetest.io/). +2. Create an [Organization](/concepts/organizations) and [Environment](/concepts/environments). +3. Copy your [Tracetest Organization API Key/Token and Environment ID](https://app.tracetest.io/retrieve-token). diff --git a/docs/docs/getting-started/install-agent.mdx b/docs/docs/getting-started/install-agent.mdx new file mode 100644 index 0000000000..087dbd3fa7 --- /dev/null +++ b/docs/docs/getting-started/install-agent.mdx @@ -0,0 +1,210 @@ +--- +id: install-agent +title: Start Tracetest Agent +description: Get started by starting Tracetest Agent! Tracetest allows you to quickly build integration and end-to-end tests, powered by your OpenTelemetry traces. +hide_table_of_contents: true +keywords: + - tracetest + - trace-based testing + - observability + - distributed tracing + - testing + - tracetest agent +image: https://res.cloudinary.com/djwdcmwdz/image/upload/v1698686403/docs/Blog_Thumbnail_14_rsvkmo.jpg +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import CodeBlock from '@theme/CodeBlock'; +import GtagInstallCliTabs from '@site/src/components/GtagInstallCliTabs'; + +[Tracetest Agent](/concepts/agent) runs alongside your apps, in the same environment/network, to do two things: + +1. Run tests against your apps. +2. Ingest traces from your apps. + +This page explains (1), how to start Tracetest Agent to enable running tests against your apps. Tracetest Agent can run either locally on your machine or as a container in Docker or Kubernetes. + + + + + +{`tracetest start --api-key --environment `} + + + +{`Tracetest start launches a lightweight agent. It enables you to run tests and collect traces with Tracetest. +Once started, Tracetest Agent exposes OTLP ports 4317 and 4318 to ingest traces via gRCP and HTTP. + + INFO Running in desktop mode... + INFO Starting Agent with name... +Agent is started! Leave the terminal open so tests can be run and traces gathered from this environment. +You can: +> Open Tracetest in a browser to this environment + (Experimental) Open Dashboard + Stop this agent`} + + + + + + +{`docker run \\\n --name tracetest-agent \\\n -p 4317:4317 \\\n -p 4318:4318 \\\n -e TRACETEST_API_KEY="" \\\n -e TRACETEST_ENVIRONMENT_ID="" \\\n kubeshop/tracetest-agent`} + + +:::note Docker Network +Running a test against `localhost` will resolve as `127.0.0.1` inside the Tracetest Agent container. + +To run tests against apps running on your local machine, you have two options: + +1. Run Tracetest Agent locally with the `tracetest start` command. +2. Add Tracetest Agent to the same network and use service name mapping. *Example: Instead of running an app on `localhost:8080`, add it to your Docker Compose file, connect it to the same network as your Tracetest Agent service, and use `:8080` in the URL field when creating a test.* + +You can reach services running on your local machine using: + +- Linux (docker version < 20.10.0): `172.17.0.1:8080` +- MacOS (docker version >= 18.03) and Linux (docker version >= 20.10.0): `host.docker.internal:8080` +::: + + + + + +{`tracetest-agent: + image: kubeshop/tracetest-agent + environment: + - TRACETEST_API_KEY= + - TRACETEST_ENVIRONMENT_ID= + ports: + - 4317:4317 + - 4318:4318`} + + +:::note Docker Network +Running a test against `localhost` will resolve as `127.0.0.1` inside the Tracetest Agent container. + +To run tests against apps running on your local machine you have two options: + +1. Run Tracetest Agent locally with the `tracetest start` command. +2. Add Tracetest Agent to the same network and use service name mapping. *Example: Instead of running an app on `localhost:8080`, add it to your Docker Compose file, connect it to the same network as your Tracetest Agent service, and use `:8080` in the URL field when creating a test.* + +You can reach services running on your local machine using: + +- Linux (docker version < 20.10.0): `172.17.0.1:8080` +- MacOS (docker version >= 18.03) and Linux (docker version >= 20.10.0): `host.docker.internal:8080` +::: + + + + + +{`--- +# Service +apiVersion: v1 +kind: Service +metadata: + name: tracetest-agent + labels: + app.kubernetes.io/name: tracetest-agent + app.kubernetes.io/instance: tracetest-agent +spec: + selector: + app.kubernetes.io/name: tracetest-agent + app.kubernetes.io/instance: tracetest-agent + ports: + - name: grpc-collector-entrypoint + protocol: TCP + port: 4317 + targetPort: 4317 + - name: http-collector-entrypoint + protocol: TCP + port: 4318 + targetPort: 4318 +--- +# Deployment +apiVersion: apps/v1 +kind: Deployment +metadata: + name: tracetest-agent + labels: + app: tracetest-agent + app.kubernetes.io/name: tracetest-agent + app.kubernetes.io/instance: tracetest-agent +spec: + selector: + matchLabels: + app.kubernetes.io/name: tracetest-agent + app.kubernetes.io/instance: tracetest-agent + template: + metadata: + labels: + app.kubernetes.io/name: tracetest-agent + app.kubernetes.io/instance: tracetest-agent + spec: + containers: + - name: agent + image: "kubeshop/tracetest-agent:latest" + imagePullPolicy: Always + args: [ + "--environment", + "", # Add your env id + "--api-key", + "$TRACETEST_API_KEY", + "--server-url", + "https://app.tracetest.io", + ] + env: + - name: TRACETEST_API_KEY + value: "" # Add your API key +`} + + + +{`kubectl apply -f ./tracetest-agent.yaml`} + + +:::note K8s Network +Make sure to check use the correct `` if you edit the Tracetest Agent `service` name. + +Running a test against `localhost` will resolve as `127.0.0.1` inside the Tracetest Agent container. +Make sure to run tests using the internal Kubernetes service networking eg: `http://api.default.svc.cluster.local:port`. +::: + + + + + +{`helm repo add tracetestcloud https://kubeshop.github.io/tracetest-cloud-charts --force-update && \\ + +helm install agent tracetestcloud/tracetest-agent \\ +--set agent.apiKey= --set agent.environmentId=`} + + +:::note K8s Network +Running a test against `localhost` will resolve as `127.0.0.1` inside the Tracetest Agent container. +Make sure to run tests using the internal Kubernetes service networking eg: `http://pokeshop-pokemon-api:8081`. +::: + + + diff --git a/docs/docs/getting-started/install-cli.mdx b/docs/docs/getting-started/install-cli.mdx new file mode 100644 index 0000000000..9240d52c3e --- /dev/null +++ b/docs/docs/getting-started/install-cli.mdx @@ -0,0 +1,32 @@ +--- +id: install-cli +title: Install Tracetest CLI +description: Get started by installing Tracetest CLI! Tracetest allows you to quickly build integration and end-to-end tests, powered by your OpenTelemetry traces. +hide_table_of_contents: true +keywords: + - tracetest + - trace-based testing + - observability + - distributed tracing + - testing + - cli +image: https://res.cloudinary.com/djwdcmwdz/image/upload/v1698686403/docs/Blog_Thumbnail_14_rsvkmo.jpg +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import GtagInstallCliTabs from '@site/src/components/GtagInstallCliTabs'; + +:::note +This getting started guide is a quick start with [Cloud-based Managed Tracetest](https://app.tracetest.io/). To use [Enterprise On-prem Tracetest, refer to this guide](/install/on-prem-helm). +::: + +1. Install the Tracetest CLI. + + + +2. Configure the CLI with your Organization API Key/Token and Environment ID. + + ```bash title="Terminal" + tracetest configure -t --environment + ``` diff --git a/docs/docs/index.mdx b/docs/docs/index.mdx index c772b3915d..3ed85c7359 100644 --- a/docs/docs/index.mdx +++ b/docs/docs/index.mdx @@ -106,7 +106,7 @@ Tracetest is a cloud-native application, designed to run in the cloud. [Get star ### Cloud-based Managed Tracetest (Free to get started!) -The easiest and most reliable way to test microservices and distributed apps with OpenTelemetry distributed traces is signing up for free at [app.tracetest.io](https://app.tracetest.io/). After creating an account, getting started is as easy as [installing the Tracetest Agent](/getting-started/installation). +The easiest and most reliable way to test microservices and distributed apps with OpenTelemetry distributed traces is signing up for free at [app.tracetest.io](https://app.tracetest.io/). After creating an account, getting started is as easy as [installing the Tracetest Agent](/getting-started/install-agent). ### Enterprise Self-hosted Tracetest (Free trial, no credit card required) diff --git a/docs/docs/install/on-prem-helm-kind.mdx b/docs/docs/install/on-prem-helm-kind.mdx new file mode 100644 index 0000000000..d0b4223215 --- /dev/null +++ b/docs/docs/install/on-prem-helm-kind.mdx @@ -0,0 +1,52 @@ +--- +id: on-prem-helm-kind +title: Install with Helm in Kind (Simplified) +hide_table_of_contents: false +description: Installation and deployment instructions for using Helm to deploy Enterprise self-hosted Tracetest and use the On-Prem Tracetest Control Plane / Dashboard. +keywords: + - tracetest + - trace-based testing + - observability + - distributed tracing + - testing +image: https://res.cloudinary.com/djwdcmwdz/image/upload/v1698686403/docs/Blog_Thumbnail_14_rsvkmo.jpg +--- + +:::note For Development Environment +This installation is meant for testing purposes only. It uses self signed certificates so your browser will show a warning about it. +::: + +:::tip For Production +For the Production-ready installation: + +- [View the official Helm chart readme](https://github.com/kubeshop/tracetest-cloud-charts/blob/main/README.md). +- [View the official installation docs](/install/on-prem-helm). +::: + +1. Install [Helm](https://helm.sh/) and [kind](https://kind.sigs.k8s.io/) on your machine. Clone the official Tracetest Helm chart. + +```sh +git clone https://github.com/kubeshop/tracetest-cloud-charts.git +cd ./tracetest-cloud-charts +``` + +2. Request a **license key, [here](https://tracetest.io/on-prem-installation)**. + +3. Run the setup script with a demo. Add your license key when you get prompted. + +```sh +sh ./scripts/setup_kind_cluster.sh --install-demo +``` + +4. Add the following lines to your `/etc/hosts` file to access Tracetest. + +```sh +sudo sh -c 'echo "127.0.0.1 tracetest.localdev" >> /etc/hosts' +sudo sh -c 'echo "127.0.0.1 pokeshop.localdev" >> /etc/hosts' +``` + +This setup will configure a local kind cluster with Tracetest On-Prem and the [Pokeshop API demo](/live-examples/pokeshop/overview), with all networking and prerequisites configured to work locally. You can go to the following links: + +- [`https://tracetest.localdev:30000`](https://tracetest.localdev:30000) - Access the Tracetest Web UI. You get a user and an organization created for you. +- [`https://pokeshop.localdev:30000`](https://pokeshop.localdev:30000) - Access the Pokeshop API demo to run tests. + diff --git a/docs/docs/tools-and-integrations/artillery-engine.mdx b/docs/docs/tools-and-integrations/artillery-engine.mdx index fee6f77002..11ed767f9f 100644 --- a/docs/docs/tools-and-integrations/artillery-engine.mdx +++ b/docs/docs/tools-and-integrations/artillery-engine.mdx @@ -51,7 +51,7 @@ This is a simple quick-start guide on how to use the Tracetest `artillery-engine **Tracetest Account**: -- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/installation) docs. +- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/overview) docs. - Create an [environment](/concepts/environments). - Create an [environment token](/concepts/environment-tokens). - Have access to the environment's [agent API key](/configuration/agent). diff --git a/docs/docs/tools-and-integrations/artillery-plugin.mdx b/docs/docs/tools-and-integrations/artillery-plugin.mdx index 57fff9e166..822fe9bcc7 100644 --- a/docs/docs/tools-and-integrations/artillery-plugin.mdx +++ b/docs/docs/tools-and-integrations/artillery-plugin.mdx @@ -51,7 +51,7 @@ This is a simple quick-start guide on how to use the Tracetest `artillery-plugin **Tracetest Account**: -- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/installation) docs. +- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/overview) docs. - Create an [environment](/concepts/environments). - Create an [environment token](/concepts/environment-tokens). - Have access to the environment's [agent API key](/configuration/agent). diff --git a/docs/docs/tools-and-integrations/cypress.mdx b/docs/docs/tools-and-integrations/cypress.mdx index 7e4aed851e..7fce37a685 100644 --- a/docs/docs/tools-and-integrations/cypress.mdx +++ b/docs/docs/tools-and-integrations/cypress.mdx @@ -63,7 +63,7 @@ The `@tracetest/cypress` npm package is a Cypress plugin that allows you to run **Tracetest Account**: -- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/installation) docs. +- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/overview) docs. - Create an [environment](/concepts/environments). - Create an [environment token](/concepts/environment-tokens). - Have access to the environment's [agent API key](/configuration/agent). diff --git a/docs/docs/tools-and-integrations/k6-core.mdx b/docs/docs/tools-and-integrations/k6-core.mdx index 6f00792a2f..3e58e2c50a 100644 --- a/docs/docs/tools-and-integrations/k6-core.mdx +++ b/docs/docs/tools-and-integrations/k6-core.mdx @@ -68,7 +68,7 @@ sequenceDiagram **Trecetest Server:** You'll need to have a running instance of Tracetest which is going to be executing your tests and assertions. -To do so, you can follow the instructions defined in the [documentation](../getting-started/installation.mdx). +To do so, you can follow the instructions defined in the [documentation](/getting-started/overview). **XK6:** To start using the Tracetest k6 binary you need to have the xk6 builder installed on your machine. You can follow the instructions defined in this [page](https://github.com/grafana/xk6/) to do that. diff --git a/docs/docs/tools-and-integrations/k6.mdx b/docs/docs/tools-and-integrations/k6.mdx index 9aca67f71c..2a95ab3563 100644 --- a/docs/docs/tools-and-integrations/k6.mdx +++ b/docs/docs/tools-and-integrations/k6.mdx @@ -79,7 +79,7 @@ This is a simple quick start guide on how to run the Tracetest k6 extension to r **Tracetest Account**: -- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/installation) docs. +- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/overview) docs. - Create an [environment](/concepts/environments). - Create an [environment token](/concepts/environment-tokens). - Have access to the environment's [agent API key](/configuration/agent). diff --git a/docs/docs/tools-and-integrations/playwright.mdx b/docs/docs/tools-and-integrations/playwright.mdx index 2818d32fbb..2436e4dd0a 100644 --- a/docs/docs/tools-and-integrations/playwright.mdx +++ b/docs/docs/tools-and-integrations/playwright.mdx @@ -71,7 +71,7 @@ The [`@tracetest/playwright`](https://www.npmjs.com/package/@tracetest/playwrigh **Tracetest Account**: -- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/installation) docs. +- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/overview) docs. - Create an [environment](/concepts/environments). - Create an [environment token](/concepts/environment-tokens). - Have access to the environment's [agent API key](/configuration/agent). diff --git a/docs/docs/tools-and-integrations/testkube.mdx b/docs/docs/tools-and-integrations/testkube.mdx index 6a9bfaa33c..ee73c48033 100644 --- a/docs/docs/tools-and-integrations/testkube.mdx +++ b/docs/docs/tools-and-integrations/testkube.mdx @@ -78,7 +78,7 @@ This guide will show how to use Testkube alongside Tracetest to run your tests i **Tracetest account**: -- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/installation) docs. +- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/overview) docs. - Create an [organization](/concepts/organizations) and [environment](/concepts/environments). - Deploy the [Tracetest Agent](/configuration/agent) in your cluster. - Create an [environment token](/concepts/environment-tokens). diff --git a/docs/docs/tools-and-integrations/typescript.mdx b/docs/docs/tools-and-integrations/typescript.mdx index 688c2acd82..df0327f3eb 100644 --- a/docs/docs/tools-and-integrations/typescript.mdx +++ b/docs/docs/tools-and-integrations/typescript.mdx @@ -67,7 +67,7 @@ This is a simple quick-start guide on how to use the Tracetest `@tracetest/clien **Tracetest Account**: -- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/installation) docs. +- Sign up to [`app.tracetest.io`](https://app.tracetest.io) or follow the [get started](/getting-started/overview) docs. - Create an [environment](/concepts/environments). - Create an [environment token](/concepts/environment-tokens). - Have access to the environment's [agent API key](/configuration/agent). diff --git a/docs/sidebars.js b/docs/sidebars.js index 663fbcad84..6a641f9d98 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -523,13 +523,43 @@ const sidebars = { items: [ { type: "doc", - id: "getting-started/installation", - label: "Installing Tracetest", + id: "getting-started/create-tracetest-account", + label: "1. Create a Tracetest Account", }, { type: "doc", - id: "getting-started/open", - label: "Opening Tracetest", + id: "getting-started/install-cli", + label: "2. Install Tracetest CLI", + }, + { + type: "doc", + id: "getting-started/install-agent", + label: "3. Start Tracetest Agent", + }, + { + type: "doc", + id: "getting-started/create-response-based-test", + label: "4. Create a Response-based Test", + }, + { + type: "doc", + id: "getting-started/configure-trace-ingestion", + label: "5. Configure Trace Ingestion", + }, + { + type: "doc", + id: "getting-started/create-trace-based-test", + label: "6. Create a Trace-based Test", + }, + { + type: "doc", + id: "getting-started/create-assertions", + label: "7. Create Assertions", + }, + { + type: "doc", + id: "getting-started/automate-test-runs", + label: "8. Automate Test Runs", }, { type: "doc", @@ -585,6 +615,11 @@ const sidebars = { type: "category", label: "Enterprise self-hosted", items: [ + { + type: "doc", + id: "install/on-prem-helm-kind", + label: "Install with Helm in Kind (Simplified)", + }, { type: "doc", id: "install/on-prem-helm", diff --git a/docs/src/components/GettingStartedGuide/index.tsx b/docs/src/components/GettingStartedGuide/index.tsx index 19b1812dd0..0a4dda71f9 100644 --- a/docs/src/components/GettingStartedGuide/index.tsx +++ b/docs/src/components/GettingStartedGuide/index.tsx @@ -8,7 +8,7 @@ import Heading from '@theme/Heading'; const TracetestGettingStartedGuides = [ { name: 'Tracetest 🚀', - url: '/getting-started/installation', + url: '/getting-started/create-tracetest-account', description: ( Set up Tracetest and start trace-based testing your distributed system. diff --git a/docs/src/components/WelcomeGuide/index.tsx b/docs/src/components/WelcomeGuide/index.tsx index f165256cd1..753915057d 100644 --- a/docs/src/components/WelcomeGuide/index.tsx +++ b/docs/src/components/WelcomeGuide/index.tsx @@ -17,7 +17,7 @@ const WelcomeGuides = [ // }, { name: '👉 Getting Started', - url: './getting-started/installation', + url: './getting-started/overview', description: ( Check out guides and installation examples to get started quickly! diff --git a/docs/vercel.json b/docs/vercel.json index c1e1d9678f..0ed8537023 100644 --- a/docs/vercel.json +++ b/docs/vercel.json @@ -137,12 +137,32 @@ "statusCode": 301 }, { - "destination": "/getting-started/installation", + "destination": "/getting-started/overview", + "source": "/getting-started/open", + "statusCode": 301 + }, + { + "destination": "/getting-started/overview", + "source": "/getting-started/open/", + "statusCode": 301 + }, + { + "destination": "/getting-started/overview", + "source": "/getting-started/installation", + "statusCode": 301 + }, + { + "destination": "/getting-started/overview", + "source": "/getting-started/installation/", + "statusCode": 301 + }, + { + "destination": "/getting-started/overview", "source": "/getting-started/detailed-installation", "statusCode": 301 }, { - "destination": "/getting-started/installation", + "destination": "/getting-started/overview", "source": "/getting-started/detailed-installation/", "statusCode": 301 }, @@ -177,12 +197,12 @@ "statusCode": 301 }, { - "destination": "/getting-started/installation", + "destination": "/getting-started/overview", "source": "/deployment/overview/", "statusCode": 301 }, { - "destination": "/getting-started/installation", + "destination": "/getting-started/overview", "source": "/deployment/overview", "statusCode": 301 }, diff --git a/examples/quick-start-grpc-stream-propagation/README.md b/examples/quick-start-grpc-stream-propagation/README.md index 1b3037a95e..9b129cfa64 100644 --- a/examples/quick-start-grpc-stream-propagation/README.md +++ b/examples/quick-start-grpc-stream-propagation/README.md @@ -28,7 +28,7 @@ flowchart LR To run this example, you need to have the following tools installed: - [Docker](https://www.docker.com/) -- [Tracetest CLI](https://docs.tracetest.io/getting-started/installation#install-the-tracetest-cli) +- [Tracetest CLI](https://docs.tracetest.io/getting-started/install-cli) - [grpcurl](https://github.com/fullstorydev/grpcurl?tab=readme-ov-file#installation) You can run this example using your environment on [Tracetest](https://app.tracetest.io), or using Tracetest Core. When you have a [Tracetest Agent](https://docs.tracetest.io/configuration/agent) configured on Tracetest UI and an API Key, you can run the following commands: diff --git a/examples/quick-start-pokeshop/README.md b/examples/quick-start-pokeshop/README.md index 99d413a79f..a1ccb10f4a 100644 --- a/examples/quick-start-pokeshop/README.md +++ b/examples/quick-start-pokeshop/README.md @@ -1,6 +1,6 @@ # Quick Start - Tracetest + Pokeshop -> [Read the installation guide in our documentation.](https://docs.tracetest.io/getting-started/installation) +> [Read the installation guide in our documentation.](https://docs.tracetest.io/getting-started/overview) This examples' objective is to show how you can: diff --git a/examples/tracetest-agent/pokeshop/readme.md b/examples/tracetest-agent/pokeshop/readme.md index 4874e819d8..ea9add014e 100644 --- a/examples/tracetest-agent/pokeshop/readme.md +++ b/examples/tracetest-agent/pokeshop/readme.md @@ -1,6 +1,6 @@ # Pokeshop with Tracetest Cloud -> [Read the detailed instructions for setting up Tracetest Cloud in our documentation.](https://docs.tracetest.io/getting-started/installation) +> [Read the detailed instructions for setting up Tracetest Cloud in our documentation.](https://docs.tracetest.io/getting-started/overview) This examples' objective is to show how you can: diff --git a/examples/tracetest-lightstep-otel-demo/README.md b/examples/tracetest-lightstep-otel-demo/README.md index 5628d22489..8c7704ed4e 100644 --- a/examples/tracetest-lightstep-otel-demo/README.md +++ b/examples/tracetest-lightstep-otel-demo/README.md @@ -224,7 +224,7 @@ Increasing the duration to a more reasonable `500ms` will make the test pass. ## Run Tracetest tests with the Tracetest CLI -First, [install the CLI](https://docs.tracetest.io/getting-started/installation#install-the-tracetest-cli). +First, [install the CLI](https://docs.tracetest.io/getting-started/install-cli). Then, configure the CLI: ```bash diff --git a/examples/tracetest-new-relic-otel-demo/README.md b/examples/tracetest-new-relic-otel-demo/README.md index 403b720fee..9d9f174406 100644 --- a/examples/tracetest-new-relic-otel-demo/README.md +++ b/examples/tracetest-new-relic-otel-demo/README.md @@ -225,7 +225,7 @@ Increasing the duration to a more reasonable `500ms` will make the test pass. ## Run Tracetest tests with the Tracetest CLI -First, [install the CLI](https://docs.tracetest.io/getting-started/installation#install-the-tracetest-cli). +First, [install the CLI](https://docs.tracetest.io/getting-started/install-cli). Then, configure the CLI: ```bash