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.

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

Relocate Reference Tables docs #26870

Merged
merged 5 commits into from
Dec 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 16 additions & 10 deletions config/_default/menus/main.en.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1394,12 +1394,18 @@ menu:
parent: ddsql_editor
identifier: ddsql_editor_guide
weight: 10
- name: Reference Tables
url: reference_tables/
pre: inventories
identifier: reference_tables
parent: platform_heading
weight: 40000
- name: Sheets
url: sheets/
pre: inventories
identifier: sheets
parent: platform_heading
weight: 40000
weight: 50000
- name: Functions and Operators
url: sheets/functions_operators/
parent: sheets
Expand All @@ -1415,7 +1421,7 @@ menu:
pre: monitor
identifier: alerting
parent: platform_heading
weight: 50000
weight: 60000
- name: Configure Monitors
url: monitors/configuration/
parent: alerting
Expand Down Expand Up @@ -1626,7 +1632,7 @@ menu:
identifier: infrastructure
pre: host-map
parent: platform_heading
weight: 60000
weight: 70000
- name: Host and Container Maps
url: infrastructure/hostmap/
parent: infrastructure
Expand Down Expand Up @@ -1692,7 +1698,7 @@ menu:
identifier: metrics_top_level
pre: metric
parent: platform_heading
weight: 70000
weight: 80000
- name: Custom Metrics
url: metrics/custom_metrics/
parent: metrics_top_level
Expand Down Expand Up @@ -1798,7 +1804,7 @@ menu:
identifier: watchdog_top_level
pre: watchdog
parent: platform_heading
weight: 80000
weight: 90000
- name: Alerts
url: watchdog/alerts
identifier: watchdog_alerts
Expand Down Expand Up @@ -1829,7 +1835,7 @@ menu:
pre: bits-ai
identifier: bits_ai
parent: platform_heading
weight: 90000
weight: 100000
- name: Getting Started
url: bits_ai/getting_started
identifier: bits_ai_getting_started
Expand All @@ -1850,7 +1856,7 @@ menu:
pre: service-catalog
parent: platform_heading
identifier: service_catalog
weight: 100000
weight: 110000
- name: Customize the Service Catalog
url: service_catalog/customize
parent: service_catalog
Expand Down Expand Up @@ -1961,7 +1967,7 @@ menu:
pre: api-catalog
parent: platform_heading
identifier: api_catalog
weight: 110000
weight: 120000
- name: Exploring APIs
url: /api_catalog/explore_apis/
identifier: api_catalog_explore
Expand Down Expand Up @@ -2007,7 +2013,7 @@ menu:
pre: error-tracking
parent: platform_heading
identifier: error_tracking
weight: 120000
weight: 130000
- name: Explorer
url: error_tracking/explorer
parent: error_tracking
Expand Down Expand Up @@ -2108,7 +2114,7 @@ menu:
pre: graph-3
parent: platform_heading
identifier: change_tracking
weight: 130000
weight: 140000
- name: Service Level Objectives
url: service_management/service_level_objectives/
pre: slos
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ title: Add Custom Metadata with Reference Tables
aliases:
- /logs/guide/enrichment-tables/
- /logs/guide/reference-tables/
- /integrations/guide/reference-tables
further_reading:
- link: "/logs/log_configuration/processors"
tag: "Documentation"
Expand All @@ -22,7 +23,7 @@ further_reading:

Reference Tables allow you to combine metadata with information already in Datadog. You can define new entities like customer details, service names and information, or IP addresses by uploading a CSV file containing a table of information. The entities are represented by a primary key in a Reference Table and the associated metadata.

{{< img src="integrations/guide/reference-tables/reference-table.png" alt="A reference table with data populated in the columns for org id, org name, parent org, account owner, and csm" style="width:100%;">}}
{{< img src="reference_tables/reference-table.png" alt="A reference table with data populated in the columns for org id, org name, parent org, account owner, and csm" style="width:100%;">}}

## Validation rules

Expand All @@ -44,7 +45,7 @@ Reference Table names and column headers are validated using the following namin

Click **New Reference Table +**, then upload a CSV file, name the appropriate columns, and define the primary key for lookups.

{{< img src="integrations/guide/reference-tables/enrichment-table-setup.png" alt="The Define the Schema section showing a table with org_id marked as the primary key and columns with data for org id, org name, parent org, account owner, and csm " style="width:100%;">}}
{{< img src="reference_tables/enrichment-table-setup.png" alt="The Define the Schema section showing a table with org_id marked as the primary key and columns with data for org id, org name, parent org, account owner, and csm " style="width:100%;">}}

**Note**: The manual CSV upload method supports files up to 4MB.

Expand Down Expand Up @@ -81,7 +82,7 @@ To update Reference Tables from S3, Datadog uses the IAM role in your AWS accoun

Click **New Reference Table +**, then add a name, select Amazon S3, fill out all fields, click import, and define the primary key for lookups.

{{< img src="integrations/guide/reference-tables/configure-s3-reference-table.png" alt="The upload your data section with the Amazon S3 tile selected and data filled in for AWS Account, Bucket, and Path" style="width:100%;">}}
{{< img src="reference_tables/configure-s3-reference-table.png" alt="The upload your data section with the Amazon S3 tile selected and data filled in for AWS Account, Bucket, and Path" style="width:100%;">}}

**Note**: The upload from an S3 bucket method supports files up to 200MB.

Expand All @@ -97,11 +98,11 @@ Click **New Reference Table +**, then add a name, select Amazon S3, fill out all
4. Input and select the **Storage Blob Data Reader** Role. The [Storage Blob Data Reader role][3] allows Datadog to read and list storage containers and blobs.
5. In the **Members** tab, click **+ Select members**. Select the app registration you created in Step 1.

{{< img src="integrations/guide/reference-tables/add_members.png" alt="The Members section in the Azure Portal where a member is selected and data filled in for the Name, Object ID, and Type" style="width:85%;">}}
{{< img src="reference_tables/add_members.png" alt="The Members section in the Azure Portal where a member is selected and data filled in for the Name, Object ID, and Type" style="width:85%;">}}

After reviewing and assigning the role, you can import into Reference Tables from Azure. It may take a few minutes for your Azure configuration to update in Datadog.

{{< img src="integrations/guide/reference-tables/azure_storage.png" alt="An Azure Storage tile in the Upload or import data section of a new reference table workflow" style="width:80%;">}}
{{< img src="reference_tables/azure_storage.png" alt="An Azure Storage tile in the Upload or import data section of a new reference table workflow" style="width:80%;">}}

For more information, see the [Azure integration documentation][4].

Expand All @@ -127,11 +128,11 @@ For more information, see the [Azure integration documentation][4].
1. In the window that appears, under the "New principals" field, enter the service account email that you created and added to the GCP tile in Step 1. Under "Assign roles", select the **Storage Object Viewer** role. Click **Save**.


{{< img src="integrations/guide/reference-tables/grant_access.png" alt="Google Cloud console showing the configuration to grant access" style="width:100%;" >}}
{{< img src="reference_tables/grant_access.png" alt="Google Cloud console showing the configuration to grant access" style="width:100%;" >}}

After reviewing and assigning the role, you can import into Reference Tables from Google Cloud. It may take a few minutes for your configuration to update in Datadog.

{{< img src="integrations/guide/reference-tables/gcp_upload_import_ui.png" alt="Select GCP Storage in Upload or import data when creating a new reference table" style="width:100%;" >}}
{{< img src="reference_tables/gcp_upload_import_ui.png" alt="Select GCP Storage in Upload or import data when creating a new reference table" style="width:100%;" >}}

**Note**: The upload from cloud object storage supports files up to 200MB.

Expand Down
Loading