diff --git a/docs/docs/img/black-box-create-spec-0.14.gif b/docs/docs/img/black-box-create-spec-0.14.gif new file mode 100644 index 0000000000..62e5154a90 Binary files /dev/null and b/docs/docs/img/black-box-create-spec-0.14.gif differ diff --git a/docs/docs/img/black-box-google-0.14.png b/docs/docs/img/black-box-google-0.14.png new file mode 100644 index 0000000000..705b9f16f1 Binary files /dev/null and b/docs/docs/img/black-box-google-0.14.png differ diff --git a/docs/docs/img/black-box-google-response-0.14.png b/docs/docs/img/black-box-google-response-0.14.png new file mode 100644 index 0000000000..11d3fa74f0 Binary files /dev/null and b/docs/docs/img/black-box-google-response-0.14.png differ diff --git a/docs/docs/img/black-box-google-run-0.14.png b/docs/docs/img/black-box-google-run-0.14.png new file mode 100644 index 0000000000..3c7b544dc7 Binary files /dev/null and b/docs/docs/img/black-box-google-run-0.14.png differ diff --git a/docs/docs/img/black-box-popup-0.14.png b/docs/docs/img/black-box-popup-0.14.png new file mode 100644 index 0000000000..e59ac5abdd Binary files /dev/null and b/docs/docs/img/black-box-popup-0.14.png differ diff --git a/docs/docs/img/black-box-popup-click-0.14.png b/docs/docs/img/black-box-popup-click-0.14.png new file mode 100644 index 0000000000..d15675e869 Binary files /dev/null and b/docs/docs/img/black-box-popup-click-0.14.png differ diff --git a/docs/docs/img/black-box-settings-0.14.png b/docs/docs/img/black-box-settings-0.14.png new file mode 100644 index 0000000000..8d0f19dd44 Binary files /dev/null and b/docs/docs/img/black-box-settings-0.14.png differ diff --git a/docs/docs/img/black-box-skip-settings-0.14.png b/docs/docs/img/black-box-skip-settings-0.14.png new file mode 100644 index 0000000000..46ed4637ef Binary files /dev/null and b/docs/docs/img/black-box-skip-settings-0.14.png differ diff --git a/docs/docs/img/black-box-skip-settings-run-0.14.png b/docs/docs/img/black-box-skip-settings-run-0.14.png new file mode 100644 index 0000000000..2521ac65ab Binary files /dev/null and b/docs/docs/img/black-box-skip-settings-run-0.14.png differ diff --git a/docs/docs/img/black-box-test-tab-0.14.png b/docs/docs/img/black-box-test-tab-0.14.png new file mode 100644 index 0000000000..9ba93eb1e7 Binary files /dev/null and b/docs/docs/img/black-box-test-tab-0.14.png differ diff --git a/docs/docs/web-ui/black-box-testing.mdx b/docs/docs/web-ui/black-box-testing.mdx new file mode 100644 index 0000000000..feee23495f --- /dev/null +++ b/docs/docs/web-ui/black-box-testing.mdx @@ -0,0 +1,85 @@ +--- +id: black-box-testing +title: Enabling Black-Box Testing +description: Tracetest enables configuring tests to run in a black box environment visually in the Tracetest Web UI. +hide_table_of_contents: false +keywords: + - tracetest + - observability + - distributed tracing + - testing + - black-box testing +image: https://res.cloudinary.com/djwdcmwdz/image/upload/v1698686403/docs/Blog_Thumbnail_14_rsvkmo.jpg +--- + +This page shows how to configure black box testing in the Tracetest Web UI. + +👉 **Join our [shared Pokeshop API Demo environment](https://app.tracetest.io/organizations/ttorg_2179a9cd8ba8dfa5/invites/invite_760904a64b4b9dc9/accept) and try creating a Test yourself!** + +![Main Screen](../img/main-screen-0.14.png) + +Click the **Create** button: + +![Create a Test Button](../img/create-test-button-0.14.png) + +The "Create New Test" dialog appears. +The option to choose the kind of trigger to initiate the trace is presented: + +- HTTP Request - Create a basic HTTP request. +- GRPC Request - Test and debug your GRPC request. +- Kafka - Test consumers with Kafka messages. +- TraceID - Define your test via a TraceID (Not Available for Black-Box Testing). + +Then, click one of the options to continue: + +![Choose Trigger](../img/choose-trigger-0.14.png) + +In this example, HTTP Request has been chosen. + +![Choose Example](../img/choose-example-0.14.png) + +Input the **Name** and **Trigger** details for a non-instrumented service. + +We are using a generic **GET** request to **google.com** in this case: + +![GET Google](../img/black-box-google-0.14.png) + +Click **Run**: + +![Run Test](../img/black-box-google-run-0.14.png) + +The test will start: + +![Trigger Response](../img/black-box-google-response-0.14.png) + +After a few seconds, the skip **awaiting trace** popup will show up: + +![Skip Trace Collection Popup](../img/black-box-popup-0.14.png) + +Click, the **Skip awaiting trace** button: + +![Skip Trace Collection Click](../img/black-box-popup-click-0.14.png) + +The Run will complete, showing the **Tracetest trigger** root span: + +![Tracetest Trigger Span](../img/black-box-test-tab-0.14.png) + +Create a **Test Spec** from the **Tracetest Trigger** span: + +![Create Test Spec](../img/black-box-create-spec-0.14.gif) + +To have test runs always skip the **awaiting trace** step, go to the settings tab under the trigger section: + +![Trigger Settings](../img/black-box-settings-0.14.png) + +And, enable the **Skip Trace collection** option: + +![Skip Trace Collection Setting](../img/black-box-skip-settings-0.14.png) + +Then click **Run** to save the changes: + +![Skip Trace Collection Setting Run](../img/black-box-skip-settings-run-0.14.png) + +Please visit the [Test Results](/web-ui/test-results) document for an explanation of viewing the results of a test. + +👉 **Join our [shared Pokeshop API Demo environment](https://app.tracetest.io/organizations/ttorg_2179a9cd8ba8dfa5/invites/invite_760904a64b4b9dc9/accept) and try creating a Test yourself!** diff --git a/docs/docs/web-ui/creating-tests.mdx b/docs/docs/web-ui/creating-tests.mdx index 4b897c1487..3b72568d47 100644 --- a/docs/docs/web-ui/creating-tests.mdx +++ b/docs/docs/web-ui/creating-tests.mdx @@ -20,7 +20,7 @@ Click the **Create** button: ![Create a Test Button](../img/create-test-button-0.14.png) -.The "Create New Test" dialog appears. +The "Create New Test" dialog appears. The option to choose the kind of trigger to initiate the trace is presented: - HTTP Request - Create a basic HTTP request. diff --git a/docs/sidebars.js b/docs/sidebars.js index 2358cf5bc2..20cb52c22f 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -823,6 +823,11 @@ const sidebars = { id: "web-ui/creating-test-suites", label: "Creating Test Suites", }, + { + type: "doc", + id: "web-ui/black-box-testing", + label: "Enabling Black-Box Testing", + }, { type: "doc", id: "web-ui/creating-variable-sets",