From a69b5e241bd24a01f4c64779ee40135921219025 Mon Sep 17 00:00:00 2001 From: Mendon Kissling <59585235+mendonk@users.noreply.github.com> Date: Tue, 13 Aug 2024 15:10:45 -0400 Subject: [PATCH] cleanup-and-add-api-link --- .../pages/monitoring/stream-audit-logs.adoc | 48 +++++++------------ 1 file changed, 16 insertions(+), 32 deletions(-) diff --git a/modules/operations/pages/monitoring/stream-audit-logs.adoc b/modules/operations/pages/monitoring/stream-audit-logs.adoc index 88b815f..bfd4d24 100644 --- a/modules/operations/pages/monitoring/stream-audit-logs.adoc +++ b/modules/operations/pages/monitoring/stream-audit-logs.adoc @@ -2,35 +2,19 @@ Stream your xref:astra-db-serverless:administration:view-account-audit-log.adoc[{astra_db} audit logs] through {product_name} to an external system. -To enable audit logging, provide the **full name** of your {product_name} topic and the streaming tenant's `client.conf` file to DataStax. - -== Create a {product_name} Topic for Audit Logging - -If you already have an existing {product_name} topic for audit logging, skip to the section <>. - -. Log in to the Astra console using your credentials. -. Select the appropriate organization for the streaming account you want to use. -. Click **Streaming** in the left-hand menu. -. Select an existing tenant or xref:astra-streaming:getting-started:index.adoc[Create a Streaming Tenant]. -**Note:** The tenant must be located in AWS `useast2`. -. Create a namespace in the tenant. -.. Select **Namespace and Topics** from the menu. -.. Click **Create Namespace**. -.. Enter a name for your new namespace. For example, `audit-logs`. -. Create a topic in the namespace. -.. Click **Add Topic** on the `audit-logs` namespace you just created. -.. Enter a name for your new topic. For example, `dev`. -.. The default **Persistent** and **Non-partitioned** settings are acceptable. -.. Click the new topic from the **Namespace and Topics** screen. -. Record the topic's **full name** value for your DataStax representative. -It will look like `persistent://aws-us-east-2-mk/audit-logs/dev`. -. Set up any additional topics as needed, and record the **full name** of each. - -== Download the Client Configuration File - -. From your streaming tenant, click the **Connect** tab, then click **Download client.conf**. -. The `client.conf` file is downloaded to your local machine. - -== Send Information to DataStax - -Send your topic's full address and the `client.conf` file to your DataStax representative. DataStax will complete the setup. +To enable audit log streaming, you must provide the **Full Name** of your {product_name} topic and the streaming tenant's `client.conf` file to {support_url}[{company} Support] or your account representative, or POST your configuration to the https://docs.datastax.com/en/astra-api-docs/_attachments/devops-api/index.html#tag/Organization-Operations/operation/configureTelemetry[Astra DevOps API telemetry endpoint]. + +== Create an {product_name} topic for audit logs +Audit log streaming requires a streaming tenant in the AWS `us-east-2` region. +You can create a new tenant with the xref:astra-streaming:getting-started:index.adoc[{product_name} quickstart] or use an existing {product_name} tenant. + +. In the {link-astra-portal}, go to **Streaming**. +. Select an existing tenant or xref:astra-streaming:getting-started:index.adoc#your-first-streaming-tenant[Create a Streaming Tenant] in AWS `us-east-2`. +. Add a xref:astra-streaming:getting-started:index.adoc#add-a-namespace-to-hold-topics[namespace] and xref:astra-streaming:getting-started:index.adoc#a-topic-to-organize-messages[topic] to the tenant. +. On the *Namespace and Topics* page, click the new topic, and then copy the topic's **Full Name**, such as `persistent://aws-us-east-2-mk/*NAMESPACE_NAME*/*TOPIC_NAME*`. +. If necessary, create additional audit log topics, and then record the **Full Name** for each topic. +Additional topics can help you organize audit logs by event type or other criteria. +. In the {link-astra-portal}, go to **Streaming**, and then click your audit log streaming tenant. +. On the *Connect* tab, click **Download client.conf**. +. Send your topic's full address and the `client.conf` file to your DataStax representative. DataStax will complete the setup. +.. Alternatively, POST your topic's full address and values from the `client.conf` file to the https://docs.datastax.com/en/astra-api-docs/_attachments/devops-api/index.html#tag/Organization-Operations/operation/configureTelemetry[Astra DevOps API telemetry endpoint].