Skip to content

Commit

Permalink
docs(recipes): add kafka + examples section overhaul (#3162)
Browse files Browse the repository at this point in the history
* docs(cleanup): added new links to tutorials and recipes

* docs(announcementbar): added top bar for announcements

* docs(announcement bar): fix

* docs(ex-tut): overhaul

* docs(kafka-recipe): added kafka recipe + cleanup

* docs(recipe): kafka typo fix
  • Loading branch information
adnanrahic committed Sep 18, 2023
1 parent 05bd2df commit ca4307a
Show file tree
Hide file tree
Showing 12 changed files with 822 additions and 177 deletions.
2 changes: 1 addition & 1 deletion docs/docs/configuration/overview.md
Expand Up @@ -34,7 +34,7 @@ View [configuration for OpenTelemetry Collector](./connecting-to-data-stores/ope

## Trace Data Store Configuration Examples

Examples of configuring Tracetest to access different data stores can be found in the [`examples` folder of the Tracetest GitHub repo](https://github.com/kubeshop/tracetest/tree/main/examples). Check out the [**Recipes**](../examples-tutorials/recipes.md) for guided walkthroughs of sample use cases.
Examples of configuring Tracetest to access different data stores can be found in the [`examples` folder of the Tracetest GitHub repo](https://github.com/kubeshop/tracetest/tree/main/examples). Check out the [**Recipes**](../examples-tutorials/recipes.mdx) for guided walkthroughs of sample use cases.

We will be adding new data stores over the next couple of months - [let us know](https://github.com/kubeshop/tracetest/issues/new/choose) any additional data stores you would like to see us support.

Expand Down
24 changes: 24 additions & 0 deletions docs/docs/examples-tutorials/overview.mdx
@@ -0,0 +1,24 @@
---
id: overview
title: Welcome to Tracetest Examples & Tutorials! 👋
description: Here you can find examples, recipes, tutorials, and video content to help you get started with Tracetest.
hide_table_of_contents: false
keywords:
- tracetest
- trace-based testing
- observability
- distributed tracing
- testing
image: https://res.cloudinary.com/djwdcmwdz/image/upload/v1689693872/docs/Blog_Thumbnail_28_ugy2yy.png
breadcrumb_label: Nothing
---

import CodeBlock from '@theme/CodeBlock';

Find tutorials and guides to help you get started with Tracetest.

```mdx-code-block
import {ExamplesTutorialsOverviewRow} from '@site/src/components/ExamplesTutorialsOverview';
<ExamplesTutorialsOverviewRow />
```
@@ -1,23 +1,48 @@
# Recipes
---
id: recipes
title: 🍱 Recipes
description: Here you can find tutorials to help you get started with Tracetest.
hide_table_of_contents: false
keywords:
- tracetest
- trace-based testing
- observability
- distributed tracing
- testing
image: https://res.cloudinary.com/djwdcmwdz/image/upload/v1689693872/docs/Blog_Thumbnail_28_ugy2yy.png
breadcrumb_label: Nothing
---

These recipes will show you the best practices for using Tracetest.
If you're already building something with Tracetest, explore these Recipes. They're short, self-contained, and runnable solutions to popular use cases.

## Streams and Message Queues

These recipes show how to trigger Tracetest test runs with message queues like Kafka.

- [Testing Kafka in a Go API with OpenTelemetry](./recipes/testing-kafka-go-api-with-opentelemetry-tracetest.mdx)

## Trace Data Stores

These recipes show integrations with trace data stores and tracing vendors/providers.

### OpenTelemetry Collector

This integration point uses the OpenTelemetry Collector as a router to send trace data to both Tracetest and tracing vendors/providers.
This integration point uses the OpenTelemetry Collector as a router to send trace data to Tracetest.

- [Sending traces directly to Tracetest from a Node.js app using OpenTelemetry Collector](./recipes/running-tracetest-without-a-trace-data-store.md)
- [Sending traces with manual instrumentation directly to Tracetest from a Node.js app using OpenTelemetry Collector](./recipes/running-tracetest-without-a-trace-data-store-with-manual-instrumentation.md)
- [Sending traces with manual instrumentation directly to Tracetest from a Python app using OpenTelemetry Collector](./recipes/running-python-app-with-opentelemetry-collector-and-tracetest.md)

### OpenTelemetry Collector + Tracing Vendors

This integration point uses the OpenTelemetry Collector as a router to send trace data to both Tracetest and tracing vendors/providers.

- [Sending traces to Lightstep and Tracetest from the OpenTelemetry Demo with OpenTelemetry Collector](./recipes/running-tracetest-with-lightstep.md)
- [Sending traces to New Relic and Tracetest from the OpenTelemetry Demo with OpenTelemetry Collector](./recipes/running-tracetest-with-new-relic.md)
- [Sending traces to Datadog and Tracetest from the OpenTelemetry Demo with OpenTelemetry Collector](./recipes/running-tracetest-with-datadog.md)
- [Sending traces to Honeycomb and Tracetest from a Node.js app using the OpenTelemetry Collector](./recipes/running-tracetest-with-honeycomb.md)
- [Sending traces to Dynatrace and Tracetest from the OpenTelemetry Demo with OpenTelemetry Collector](./recipes/running-tracetest-with-dynatrace.md)
- [Sending traces to SigNoz and Tracetest from the Pokeshop API with OpenTelemetry Collector](./recipes/running-tracetest-with-signoz-pokeshop.md)

### Jaeger

Expand Down

0 comments on commit ca4307a

Please sign in to comment.