Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore(docs): Cloud Agent Page #3413

Merged
merged 2 commits into from
Nov 30, 2023
Merged

chore(docs): Cloud Agent Page #3413

merged 2 commits into from
Nov 30, 2023

Conversation

xoscar
Copy link
Collaborator

@xoscar xoscar commented Nov 29, 2023

This PR adds the Cloud Agent Page

Changes

  • Adds Cloud Agent Page

Checklist

  • tested locally
  • added new dependencies
  • updated the docs
  • added a test

localhost_3000_concepts_cloud-agent

@xoscar xoscar self-assigned this Nov 29, 2023
@xoscar xoscar marked this pull request as ready for review November 29, 2023 21:13
kdhamric
kdhamric reviewed Nov 29, 2023
View reviewed changes
docs/docs/concepts/cloud-agent.mdx Outdated
---
id: cloud-agent
title: Tracetest Cloud Agent (Beta)
description: Tracetest Cloud Agent is a lightweight, dependency-free program that runs within the Tracetest Cloud Infrastructure.
Copy link
Collaborator

@kdhamric kdhamric Nov 29, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

description: Tracetest Cloud Agent allows you to run Tracetest tests against public facing endpoints without deploying the Tracetest Agent.

kdhamric
kdhamric reviewed Nov 29, 2023
View reviewed changes
docs/docs/concepts/cloud-agent.mdx Outdated
image: https://res.cloudinary.com/djwdcmwdz/image/upload/v1698686403/docs/Blog_Thumbnail_14_rsvkmo.jpg
---

Tracetest Cloud Agent is a lightweight, dependency-free program that runs within the Tracetest Cloud Infrastructure. Allowing you to trigger tests against public endpoints while collecting traces from public data stores or listening for incoming OTLP data.
Copy link
Collaborator

@kdhamric kdhamric Nov 29, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tracetest Cloud Agent allows you to run Tracetest tests against public facing endpoints without deploying the Tracetest Agent. This allowing you to trigger tests against public endpoints and collect traces information from either public trace data stores or, alternatively, directly receive incoming OTLP data.

kdhamric
kdhamric reviewed Nov 29, 2023
View reviewed changes
docs/docs/concepts/cloud-agent.mdx
Wait for the Agent information is ready:

![Cloud Agent](../img/agent-settings-cloud-0.14.png)

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Configure the public trace data store that the trace data is being written into via the configure data store tab or use the supplied OTLP endpoints to alter your OTel Collector configuration to send trace information via either gRPC or HTTP directly to Tracetest.io.

kdhamric
kdhamric reviewed Nov 29, 2023
View reviewed changes
docs/docs/concepts/cloud-agent.mdx Outdated

## How It Works

- Tracetest Cloud Agent listens for new tests you run from [Tracetest](https://app.tracetest.io). It executes tests within the Tracetest Cloud Infrastructure and returns the response from the trigger.
Copy link
Collaborator

@kdhamric kdhamric Nov 29, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tracetest Cloud Agent executes tests from Tracetest, so it must be able to reach the public endpoint. It gathers the response from the trigger and updates the test run.

kdhamric
kdhamric reviewed Nov 29, 2023
View reviewed changes
docs/docs/concepts/cloud-agent.mdx Outdated
## How It Works

- Tracetest Cloud Agent listens for new tests you run from [Tracetest](https://app.tracetest.io). It executes tests within the Tracetest Cloud Infrastructure and returns the response from the trigger.
- Tracetest Cloud Agent listens on OTLP ports `4317` (gRPC) and `4318` (HTTP) for OpenTelemetry trace spans to capture distributed trace data and relay it to [Tracetest](https://app.tracetest.io).
Copy link
Collaborator

@kdhamric kdhamric Nov 29, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tracetest Cloud Agent listens on OTLP ports 4317 (gRPC) and 4318 (HTTP) for OpenTelemetry trace spans to capture distributed trace data and relay it to Tracetest.

kdhamric
kdhamric reviewed Nov 29, 2023
View reviewed changes
docs/docs/concepts/cloud-agent.mdx Outdated

- Tracetest Cloud Agent listens for new tests you run from [Tracetest](https://app.tracetest.io). It executes tests within the Tracetest Cloud Infrastructure and returns the response from the trigger.
- Tracetest Cloud Agent listens on OTLP ports `4317` (gRPC) and `4318` (HTTP) for OpenTelemetry trace spans to capture distributed trace data and relay it to [Tracetest](https://app.tracetest.io).
- Be able to connect to a publicly reachable trace data store. Eg. a Grafana Cloud Tempo instance.
Copy link
Collaborator

@kdhamric kdhamric Nov 29, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Alternatively, the Tracetest Cloud Agent can gather the associated trace data from a publicly reachable trace data store. Eg. a Grafana Cloud Tempo instance which has been configured for this environment via the Configure Data Store tab.

kdhamric
kdhamric requested changes Nov 29, 2023
View reviewed changes
Copy link
Collaborator

@kdhamric kdhamric left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I altered some wording...

jfermi
jfermi reviewed Nov 29, 2023
View reviewed changes
docs/docs/concepts/cloud-agent.mdx Outdated

### Prerequisites

- Not supported for **localMode**
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Not supported for **localMode**
- Not supported for **localMode**.

jfermi
jfermi reviewed Nov 29, 2023
View reviewed changes
docs/docs/concepts/cloud-agent.mdx Outdated
### Prerequisites

- Not supported for **localMode**
- Having Admin level access to the Environment
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Having Admin level access to the Environment
- Having Admin level access to the Environment.

jfermi
jfermi reviewed Nov 29, 2023
View reviewed changes
Copy link
Member

@jfermi jfermi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A couple of editing suggestions.

@xoscar xoscar merged commit cab0d5d into main Nov 30, 2023
38 checks passed
@xoscar xoscar deleted the chore/cloud-agent branch November 30, 2023 16:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jfermi jfermi jfermi left review comments

@kdhamric kdhamric kdhamric requested changes

@adnanrahic adnanrahic Awaiting requested review from adnanrahic

Assignees

@xoscar xoscar

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@xoscar @kdhamric @jfermi