From 62ff17dfb2da657ab986f5c018354297db8e9e54 Mon Sep 17 00:00:00 2001 From: Adnan Rahic Date: Wed, 25 Sep 2024 20:33:15 +0200 Subject: [PATCH] docs(get-started): remove "installation" page --- README.md | 10 ++-- docs/docs/ci-cd-automation/overview.mdx | 2 +- .../docs/ci-cd-automation/tekton-pipeline.mdx | 2 +- .../ci-cd-automation/testkube-pipeline.mdx | 2 +- docs/docs/cli/cli-installation-reference.mdx | 2 +- docs/docs/concepts/agent.mdx | 2 +- ...nce-tests-with-artillery-and-tracetest.mdx | 2 +- ...-opentelemetry-collector-and-tracetest.mdx | 2 +- ...-tests-with-tracetest-graphql-pokeshop.mdx | 2 +- ...tests-with-tracetest-playwright-engine.mdx | 2 +- .../running-tracetest-with-aws-x-ray-adot.mdx | 4 +- ...ning-tracetest-with-aws-x-ray-pokeshop.mdx | 4 +- .../running-tracetest-with-aws-x-ray.mdx | 4 +- ...test-with-azure-app-insights-collector.mdx | 4 +- ...etest-with-azure-app-insights-pokeshop.mdx | 2 +- ...ning-tracetest-with-azure-app-insights.mdx | 4 +- .../running-tracetest-with-datadog.mdx | 2 +- .../running-tracetest-with-dynatrace.mdx | 2 +- ...g-tracetest-with-elastic-opentelemetry.mdx | 4 +- .../running-tracetest-with-elasticapm.mdx | 4 +- ...test-with-grafana-cloud-tempo-pokeshop.mdx | 4 +- ...ing-tracetest-with-grafana-cloud-tempo.mdx | 4 +- ...-tracetest-with-grafana-tempo-pokeshop.mdx | 4 +- .../running-tracetest-with-honeycomb.mdx | 2 +- .../recipes/running-tracetest-with-jaeger.mdx | 4 +- .../running-tracetest-with-lightstep.mdx | 2 +- .../running-tracetest-with-new-relic.mdx | 2 +- .../running-tracetest-with-opensearch.mdx | 4 +- ...running-tracetest-with-signoz-pokeshop.mdx | 4 +- .../running-tracetest-with-sumologic.mdx | 4 +- .../recipes/running-tracetest-with-tempo.mdx | 4 +- ...data-store-with-manual-instrumentation.mdx | 2 +- ...g-tracetest-without-a-trace-data-store.mdx | 2 +- ...hetic-monitoring-trace-based-api-tests.mdx | 2 +- ...onitoring-trace-based-playwright-tests.mdx | 2 +- ...e-workers-with-opentelemetry-tracetest.mdx | 4 +- ...vices-with-tyk-opentelemetry-tracetest.mdx | 2 +- ...ka-go-api-with-opentelemetry-tracetest.mdx | 2 +- ...functions-with-opentelemetry-tracetest.mdx | 4 +- .../create-response-based-test.mdx | 2 +- docs/docs/index.mdx | 2 +- docs/docs/install/on-prem-helm-kind.mdx | 52 +++++++++++++++++++ .../artillery-engine.mdx | 2 +- .../artillery-plugin.mdx | 2 +- docs/docs/tools-and-integrations/cypress.mdx | 2 +- docs/docs/tools-and-integrations/k6-core.mdx | 2 +- docs/docs/tools-and-integrations/k6.mdx | 2 +- .../tools-and-integrations/playwright.mdx | 2 +- docs/docs/tools-and-integrations/testkube.mdx | 2 +- .../tools-and-integrations/typescript.mdx | 2 +- docs/sidebars.js | 15 ++---- .../components/GettingStartedGuide/index.tsx | 2 +- docs/src/components/WelcomeGuide/index.tsx | 2 +- docs/vercel.json | 28 ++++++++-- .../README.md | 2 +- examples/quick-start-pokeshop/README.md | 2 +- examples/tracetest-agent/pokeshop/readme.md | 2 +- .../tracetest-lightstep-otel-demo/README.md | 2 +- .../tracetest-new-relic-otel-demo/README.md | 2 +- 59 files changed, 158 insertions(+), 91 deletions(-) create mode 100644 docs/docs/install/on-prem-helm-kind.mdx 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/create-response-based-test.mdx b/docs/docs/getting-started/create-response-based-test.mdx index ba3252f9e6..7366d05910 100644 --- a/docs/docs/getting-started/create-response-based-test.mdx +++ b/docs/docs/getting-started/create-response-based-test.mdx @@ -26,7 +26,7 @@ To create a test you define a `trigger`. A trigger is an action that executes an 5. Kafka :::note -Playwright enables an exceptionaly useful technique: true end-to-end testing, when you can start you test from the web UI and explore the entire intenal process of that request. +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: 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..9f58e15f3d --- /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 b9acc69058..1929ce420e 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -561,16 +561,6 @@ const sidebars = { id: "getting-started/automate-test-runs", label: "8. Automate Test Runs", }, - { - type: "doc", - id: "getting-started/installation", - label: "Installing Tracetest", - }, - { - type: "doc", - id: "getting-started/open", - label: "Opening Tracetest", - }, { type: "doc", id: "getting-started/no-otel", @@ -625,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..4859c2e80f 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/overview", + "statusCode": 301 + }, + { + "destination": "/getting-started/overview", + "source": "/getting-started/overview/", + "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