-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Add CloudPrem quickstart #33736
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
Merged
+106
−8
Merged
Add CloudPrem quickstart #33736
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,93 @@ | ||
| --- | ||
| title: CloudPrem Quickstart | ||
| description: Get started with CloudPrem locally in less than 5 minutes | ||
| further_reading: | ||
| - link: "/cloudprem/install/docker/" | ||
| tag: "Documentation" | ||
| text: "CloudPrem Docker Installation" | ||
| - link: "/cloudprem/ingest_logs/rest_api/" | ||
| tag: "Documentation" | ||
| text: "CloudPrem REST API" | ||
| --- | ||
|
|
||
| {{< callout url="https://www.datadoghq.com/product-preview/cloudprem/" btn_hidden="false" header="CloudPrem is in Preview" >}} | ||
| Join the CloudPrem Preview to access new self-hosted log management features. | ||
| {{< /callout >}} | ||
|
|
||
| ## Overview | ||
|
|
||
| This quickstart covers the following: | ||
| 1. Start CloudPrem locally using Docker. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I might consider making these steps anchor links down to each section; this can help users if they are, for example, particularly interested in sending a demo log. It's not a long page, though, and there's the right navigation, so I'll leave it up to you. |
||
| 2. Verify the cluster status. | ||
| 3. Send a "Hello World" log. | ||
| 4. View the log in the Datadog Log Explorer. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - Ask for the [CloudPrem Preview][1]. | ||
| - **Datadog API Key**: [Get your API key][2]. | ||
| - **Docker**: [Install Docker][3]. | ||
|
|
||
| ## Step 1: Start CloudPrem | ||
|
|
||
| Run the following command in your terminal to start a local CloudPrem instance. Replace `<YOUR_API_KEY>` with your actual Datadog API Key. | ||
|
|
||
| ```shell | ||
| export DD_API_KEY="<YOUR_API_KEY>" | ||
| export DD_SITE="datadoghq.com" | ||
|
|
||
| docker run -d \ | ||
| --name cloudprem \ | ||
| -v $(pwd)/qwdata:/quickwit/qwdata \ | ||
| -e DD_SITE=${DD_SITE} \ | ||
| -e DD_API_KEY=${DD_API_KEY} \ | ||
| -p 127.0.0.1:7280:7280 \ | ||
| datadog/cloudprem run | ||
| ``` | ||
|
|
||
| ## Step 2: Verify status in the CloudPrem console | ||
|
|
||
| In Datadog, go to the [CloudPrem console][4] and check that your cluster is connected. You should see the `connected` status. | ||
|
|
||
| In the CloudPrem console, you can edit the cluster metadata and rename your cluster to `demo`. | ||
|
|
||
| {{< img src="/cloudprem/quickstart/clouprem_console.png" alt="Screenshot of the CloudPrem console showing the cluster connected status" style="width:100%;" >}} | ||
|
|
||
| ## Step 3: Send a log | ||
|
|
||
| In your terminal, send a "Hello World" log entry directly to your local CloudPrem instance using the API: | ||
|
|
||
| ```shell | ||
| curl -X POST "http://localhost:7280/api/v2/logs" \ | ||
| -H "Content-Type: application/json" \ | ||
| -H "DD-API-KEY: ${DD_API_KEY}" \ | ||
| -d '[ | ||
| { | ||
| "message": "Hello world from CloudPrem", | ||
| "level": "info", | ||
| "service": "demo" | ||
| } | ||
| ]' | ||
| ``` | ||
|
|
||
| ## Step 4: Explore logs | ||
|
|
||
| 1. Go to the [Datadog Log Explorer][5]. | ||
| 2. On the left facet panel, select the checkbox for your index under **CLOUDPREM INDEXES**. | ||
| 3. You should see your "Hello world from CloudPrem" log entry. | ||
|
|
||
| {{< img src="/cloudprem/quickstart/cloudprem_indexes.png" alt="The CloudPrem index selection in the Datadog Log Explorer" style="width:100%;" >}} | ||
|
|
||
| ## Next steps | ||
|
|
||
| With CloudPrem running, you can: | ||
| - [Send logs with the Datadog Agent][6] to automatically collect logs from your containers. | ||
| - [Send logs with Observability Pipelines][7]. | ||
|
|
||
| [1]: https://www.datadoghq.com/product-preview/cloudprem/ | ||
| [2]: /account_management/api-app-keys/#add-an-api-key-or-client-token | ||
| [3]: https://docs.docker.com/get-docker/ | ||
| [4]: https://app.datadoghq.com/cloudprem | ||
| [5]: https://app.datadoghq.com/logs?query=index=cloudprem-demo&storage=hot | ||
| [6]: /cloudprem/ingest_logs/datadog_agent | ||
| [7]: /cloudprem/ingest_logs/observability_pipelines/ | ||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd also consider adding a link to this page: https://docs-staging.datadoghq.com/fmassot/cloudprem-quickstart/cloudprem/