Skip to content

Commit 36364ed

Browse files
committed
Update CloudPrem doc
1 parent 4970f73 commit 36364ed

21 files changed

+721
-142
lines changed

content/en/cloudprem/_index.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -12,20 +12,22 @@ private: true
1212

1313
Datadog CloudPrem is a self-hosted log management solution that enables cost-effective log ingestion, processing, indexing, and search capabilities within your own infrastructure. Built to meet data residency, stringent security, and high-volume requirements, CloudPrem integrates with the Datadog platform to provide log analysis, visualization, and alerting — all while keeping your log data at rest within your infrastructure boundaries.
1414

15+
## Key features
16+
17+
- **Self-hosted**: Deploy CloudPrem within your own infrastructure and keep your logs on your object storage
18+
- **Cost-effective**: Reduce log management infra costs while maintaining full observability
19+
- **Scalable**: Horizontally scalable architecture to handle high-volume log ingestion
20+
- **Integrated in Datadog**
21+
1522
## Get started
1623

24+
Follow these steps to deploy and configure CloudPrem:
25+
1726
{{< whatsnext >}}
18-
{{< nextlink href="/cloudprem/installation/" >}}Install CloudPrem and Send Logs with the Agent {{< /nextlink >}}
19-
{{< nextlink href="/cloudprem/ingress/" >}}Configure CloudPrem Ingress{{< /nextlink >}}
20-
{{< nextlink href="/cloudprem/aws_config" >}}Configure AWS{{< /nextlink >}}
21-
{{< nextlink href="/cloudprem/processing/" >}}Configure CloudPrem Log Processing{{< /nextlink >}}
22-
{{< nextlink href="/cloudprem/cluster/" >}}Learn more about Cluster Sizing and Operations{{< /nextlink >}}
23-
{{< nextlink href="/cloudprem/architecture/" >}}Learn more about CloudPrem Architecture{{< /nextlink >}}
27+
{{< nextlink href="/cloudprem/getting-started/" >}}Prerequisites and Architecture{{< /nextlink >}}
28+
{{< nextlink href="/cloudprem/install/" >}}Install CloudPrem{{< /nextlink >}}
29+
{{< nextlink href="/cloudprem/ingest-logs/" >}}Set up Log Ingestion{{< /nextlink >}}
30+
{{< nextlink href="/cloudprem/configure/" >}}Configure CloudPrem{{< /nextlink >}}
31+
{{< nextlink href="/cloudprem/manage/" >}}Manage and Monitor{{< /nextlink >}}
2432
{{< nextlink href="/cloudprem/troubleshooting/" >}}Troubleshooting{{< /nextlink >}}
2533
{{< /whatsnext >}}
26-
27-
28-
[1]: https://kubernetes-sigs.github.io/aws-load-balancer-controller/latest/deploy/installation/
29-
[2]: /cloudprem/installation/
30-
[3]: /cloudprem/processing/
31-
[4]: /cloudprem/architecture/
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
2+
---
3+
title: Configure CloudPrem
4+
description: Learn how to configure and customize your CloudPrem deployment for optimal performance and security
5+
private: true
6+
---
7+
8+
## Overview
9+
10+
After installing CloudPrem, you need at leat to configure your Datadog account, you might also want to adjust the cluster size, configure ingress or processing.
11+
12+
{{< whatsnext >}}
13+
{{< nextlink href="/cloudprem/configure/ingress/" >}}Ingress Configuration{{< /nextlink >}}
14+
{{< nextlink href="/cloudprem/configure/processing/" >}}Log Processing Configuration{{< /nextlink >}}
15+
{{< nextlink href="/cloudprem/configure/cluster-sizing/" >}}Cluster Sizing and Performance{{< /nextlink >}}
16+
{{< /whatsnext >}}
17+
18+
## Further reading
19+
20+
{{< partial name="whats-next/whats-next.html" >}}

content/en/cloudprem/cluster.md renamed to content/en/cloudprem/configure/cluster-sizing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Cluster Sizing and Operations
2+
title: Cluster Sizing
33
description: Learn about cluster sizing, scaling, monitoring, and maintenance for CloudPrem
44
private: true
55
further_reading:
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
## Configure your Datadog account
2+
3+
You need to reach out to [Datadog support][6] and give the public DNS of CloudPrem so that you can search into your CloudPrem cluster from Datadog UI.
4+
5+
### Searching your CloudPrem logs in the Logs Explorer
6+
7+
After your Datadog account is configured, you are ready to search into the `cloudprem` index by typing it in the search bar or selecting it in facets.
8+
9+
**Note**: You cannot query CloudPrem indexes alongside other indexes. Additionally, Flex Logs are not supported with CloudPrem indexes.
10+
11+
{{< img src="/cloudprem/installation/filter_index_cloudprem.png" alt="Screenshot of the Logs Explorer interface showing how to filter logs by selecting the cloudprem index in the facets panel" style="width:70%;" >}}

content/en/cloudprem/ingress.md renamed to content/en/cloudprem/configure/ingress.md

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,24 +6,21 @@ further_reading:
66
- link: "/cloudprem/"
77
tag: "Documentation"
88
text: "CloudPrem Overview"
9-
- link: "/cloudprem/installation/"
9+
- link: "/cloudprem/install/"
1010
tag: "Documentation"
11-
text: "Install CloudPrem and Send Logs with the Agent"
12-
- link: "/cloudprem/aws_config"
11+
text: "Install CloudPrem"
12+
- link: "/cloudprem/install/aws_config/"
1313
tag: "Documentation"
14-
text: "Configure AWS"
15-
- link: "/cloudprem/processing/"
14+
text: "AWS Configuration Prerequisites"
15+
- link: "/cloudprem/configure/"
1616
tag: "Documentation"
17-
text: "Configure CloudPrem Log Processing"
18-
- link: "/cloudprem/cluster/"
17+
text: "Configure CloudPrem"
18+
- link: "/cloudprem/ingest-logs/"
1919
tag: "Documentation"
20-
text: "Learn more about Cluster Sizing and Operations"
21-
- link: "/cloudprem/architecture/"
20+
text: "Set up Log Ingestion"
21+
- link: "/cloudprem/manage/"
2222
tag: "Documentation"
23-
text: "Learn more about CloudPrem Architecture"
24-
- link: "/cloudprem/troubleshooting/"
25-
tag: "Documentation"
26-
text: "Troubleshooting"
23+
text: "Manage and Monitor"
2724
---
2825

2926
<div class="alert alert-warning">CloudPrem is in Preview.</div>
File renamed without changes.
Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
title: Set up Log Ingestion
3+
description: Configure log sources to send data to your CloudPrem deployment
4+
private: true
5+
further_reading:
6+
- link: "/cloudprem/"
7+
tag: "Documentation"
8+
text: "CloudPrem Overview"
9+
- link: "/cloudprem/install/"
10+
tag: "Documentation"
11+
text: "Install CloudPrem"
12+
- link: "/cloudprem/configure/"
13+
tag: "Documentation"
14+
text: "Configure CloudPrem"
15+
- link: "/cloudprem/manage/"
16+
tag: "Documentation"
17+
text: "Manage and Monitor"
18+
---
19+
20+
<div class="alert alert-warning">CloudPrem is in Preview.</div>
21+
22+
## Overview
23+
24+
After installing and configuring CloudPrem, you need to set up log ingestion to start sending log data from your applications and infrastructure. CloudPrem supports multiple ingestion methods to accommodate different architectures and requirements.
25+
26+
## Log ingestion methods
27+
28+
Choose the appropriate ingestion method based on your infrastructure and requirements:
29+
30+
{{< whatsnext >}}
31+
{{< nextlink href="/cloudprem/ingest-logs/datadog-agent/" >}}Datadog Agent{{< /nextlink >}}
32+
{{< nextlink href="/cloudprem/ingest-logs/observability-pipelines/" >}}Observability Pipelines{{< /nextlink >}}
33+
{{< nextlink href="/cloudprem/ingest-logs/rest-api/" >}}REST API Integration{{< /nextlink >}}
34+
{{< /whatsnext >}}
35+
36+
## Next steps
37+
38+
After setting up log ingestion:
39+
40+
1. **Configure Datadog account** - Register your CloudPrem deployment with Datadog support
41+
2. **Set up monitoring** - Add [monitoring and alerts](../manage/) for your deployment
42+
43+
## Further reading
44+
45+
{{< partial name="whats-next/whats-next.html" >}}
Lines changed: 186 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,186 @@
1+
---
2+
title: Send logs to CloudPrem with the Datadog Agent
3+
description: Configure the Datadog Agent to send logs to your CloudPrem deployment
4+
private: true
5+
disable_toc: false
6+
further_reading:
7+
- link: "/cloudprem/ingest-logs/"
8+
tag: "Documentation"
9+
text: "Log Ingestion Overview"
10+
- link: "/cloudprem/ingest-logs/observability-pipelines/"
11+
tag: "Documentation"
12+
text: "Observability Pipelines Integration"
13+
- link: "/cloudprem/ingest-logs/rest-api/"
14+
tag: "Documentation"
15+
text: "REST API Integration"
16+
- link: "/getting_started/containers/datadog_operator/"
17+
tag: "Documentation"
18+
text: "Datadog Operator Guide"
19+
---
20+
21+
## Overview
22+
23+
To send logs with the Datadog agent to CloudPrem, you need to set the two following environment variables:
24+
- `DD_LOGS_CONFIG_LOGS_DD_URL` to CloudPrem endpoint, usually `http://<RELEASE_NAME>-indexer.<NAMESPACE_NAME>.svc.cluster.local:7280`.
25+
- Optionally, `DD_LOGS_CONFIG_EXPECTED_TAGS_DURATION` to `100000` (~5 years). This ensure the Agent adds host-level tags that it knows about to each sent log. When sending logs to Datadog SaaS, those tags can be automatically added after ingestion. When sending logs to CloudPrem, we need to ensure those tags are added to each logs as CLoudPrem does not enrich those logs as the SaaS does.
26+
27+
## Send Kubernetes logs to CloudPrem with the Datadog Agent deployed with the Datadog Operator
28+
29+
Follow the [Getting Started with Datadog Operator][5] guide for installation and deployment. When you reach Step 3, use the following `datadog-agent.yaml` configuration instead of the example provided in the guide.
30+
31+
```yaml
32+
apiVersion: datadoghq.com/v2alpha1
33+
kind: DatadogAgent
34+
metadata:
35+
name: datadog
36+
spec:
37+
global:
38+
clusterName: <CLUSTER_NAME>
39+
site: datadoghq.com
40+
credentials:
41+
apiSecret:
42+
secretName: datadog-secret
43+
keyName: api-key
44+
env:
45+
- name: DD_LOGS_CONFIG_LOGS_DD_URL
46+
value: http://<RELEASE_NAME>-indexer.<NAMESPACE_NAME>.svc.cluster.local:7280
47+
- name: DD_LOGS_CONFIG_EXPECTED_TAGS_DURATION
48+
value: "100000"
49+
50+
features:
51+
logCollection:
52+
enabled: true
53+
containerCollectAll: true
54+
55+
otlp:
56+
receiver:
57+
protocols:
58+
grpc:
59+
enabled: true
60+
endpoint: 0.0.0.0:4417
61+
62+
prometheusScrape:
63+
enabled: true
64+
enableServiceEndpoints: true
65+
66+
```
67+
68+
## Configuration options
69+
70+
### Endpoint configuration
71+
72+
The Datadog Agent can be configured to send logs to CloudPrem using different endpoints:
73+
74+
**Internal cluster endpoint** (recommended for in-cluster agents):
75+
```
76+
DD_LOGS_CONFIG_LOGS_DD_URL=http://<RELEASE_NAME>-indexer.<NAMESPACE_NAME>.svc.cluster.local:7280
77+
```
78+
79+
**Internal ingress endpoint** (for agents outside the cluster):
80+
```
81+
DD_LOGS_CONFIG_LOGS_DD_URL=https://cloudprem-internal.your-domain.com
82+
```
83+
84+
### Additional Agent configuration
85+
86+
You can also configure additional features to send cluster metadata to Datadog:
87+
88+
**Prometheus metrics scraping**:
89+
```yaml
90+
features:
91+
prometheusScrape:
92+
enabled: true
93+
enableServiceEndpoints: true
94+
```
95+
96+
**OTLP logs collection** (to send Agent logs to Datadog):
97+
```yaml
98+
features:
99+
otlp:
100+
receiver:
101+
protocols:
102+
grpc:
103+
enabled: true
104+
endpoint: 0.0.0.0:4417
105+
```
106+
107+
## Alternative deployment methods
108+
109+
### Helm chart deployment
110+
111+
If you're not using the Datadog Operator, you can deploy the Agent using Helm:
112+
113+
```bash
114+
helm install datadog-agent datadog/datadog \
115+
--set datadog.apiKey=<YOUR_API_KEY> \
116+
--set datadog.logs.enabled=true \
117+
--set datadog.logs.containerCollectAll=true \
118+
--set datadog.logsConfigContainerCollectAll=true \
119+
--set agents.containers.agent.env[0].name=DD_LOGS_CONFIG_LOGS_DD_URL \
120+
--set agents.containers.agent.env[0].value=http://<RELEASE_NAME>-indexer.<NAMESPACE_NAME>.svc.cluster.local:7280
121+
```
122+
123+
### DaemonSet deployment
124+
125+
For custom deployments, set the environment variable in your DaemonSet:
126+
127+
```yaml
128+
apiVersion: apps/v1
129+
kind: DaemonSet
130+
metadata:
131+
name: datadog-agent
132+
spec:
133+
template:
134+
spec:
135+
containers:
136+
- name: agent
137+
image: gcr.io/datadoghq/agent:latest
138+
env:
139+
- name: DD_API_KEY
140+
value: <YOUR_API_KEY>
141+
- name: DD_LOGS_ENABLED
142+
value: "true"
143+
- name: DD_LOGS_CONFIG_CONTAINER_COLLECT_ALL
144+
value: "true"
145+
- name: DD_LOGS_CONFIG_LOGS_DD_URL
146+
value: "http://<RELEASE_NAME>-indexer.<NAMESPACE_NAME>.svc.cluster.local:7280"
147+
```
148+
149+
## Verification
150+
151+
### Check Agent status
152+
153+
Verify that the Agent is sending logs to CloudPrem:
154+
155+
```bash
156+
# Check Agent status and logs configuration
157+
kubectl exec -it <datadog-agent-pod> -- agent status | grep -A 10 "Logs Agent"
158+
159+
# Check Agent logs for CloudPrem connection
160+
kubectl logs <datadog-agent-pod> | grep -i cloudprem
161+
```
162+
163+
### Check logs are indexed in CloudPrem
164+
165+
This command should return indexed JSON logs:
166+
167+
```bash
168+
kubectl exec -it <RELEASE_NAME>-searcher-0 -n <NAMESPACE_NAME> -- curl 'http://localhost:7280/api/v1/datadog/search?query='
169+
```
170+
171+
## Troubleshooting
172+
173+
**Agent not sending logs**:
174+
- Verify the `DD_LOGS_CONFIG_LOGS_DD_URL` environment variable is set correctly
175+
- Check Agent pod logs: `kubectl logs <datadog-agent-pod>`
176+
- Ensure log collection is enabled: `DD_LOGS_ENABLED=true`
177+
178+
**CloudPrem not receiving logs**:
179+
- Check CloudPrem indexer logs: `kubectl logs -n <NAMESPACE_NAME> -l app=<RELEASE_NAME>-indexer`
180+
- Verify network connectivity between Agent and CloudPrem indexer
181+
- Confirm CloudPrem service is running: `kubectl get pods -n <NAMESPACE_NAME>`
182+
183+
## Further reading
184+
185+
{{< partial name="whats-next/whats-next.html" >}}
186+

0 commit comments

Comments
 (0)