Skip to content

Commit

Permalink
cleanup-and-add-api-link
Browse files Browse the repository at this point in the history
  • Loading branch information
mendonk committed Aug 13, 2024
1 parent 2234628 commit a69b5e2
Showing 1 changed file with 16 additions and 32 deletions.
48 changes: 16 additions & 32 deletions modules/operations/pages/monitoring/stream-audit-logs.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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 <<download-client-conf>>.

. 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].

0 comments on commit a69b5e2

Please sign in to comment.