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.

Sign up for GitHub

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

chore(docs):Add Obs Pipelines to docs #19201

Merged
merged 6 commits into from
Dec 11, 2023
Merged

chore(docs):Add Obs Pipelines to docs #19201

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
b6f207a
add op
maycmlee Nov 20, 2023
5717923
add newline
maycmlee Nov 27, 2023
2cf932a
Update website/content/en/docs/about/what-is-observability-pipelines.md
maycmlee Nov 27, 2023
c303ce8
move op section
maycmlee Dec 6, 2023
864faca
add datadog
maycmlee Dec 6, 2023
eed4e98
Update website/content/en/docs/setup/_index.md
maycmlee Dec 6, 2023
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
12 changes: 9 additions & 3 deletions website/config.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,23 +164,29 @@ url = "/docs/about"
parent = "about"
weight = 1

[[languages.en.menus.footer]]
name = "What is Observability Pipelines?"
url = "/docs/about/what-is-observability-pipelines"
parent = "about"
weight = 2
Comment on lines +167 to +171
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm curious, do you think it is better to link to a new page on the Vector website here or to link directly to https://www.datadoghq.com/product/observability-pipelines/, like we do in the website header?

From my understanding, /docs/about/what-is-observability-pipelines mostly duplicates the information on the linked DD page.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@barieom

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My 5c: I am in favor of having both as long as the Vector page is short and has links to the OP docs.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's add it here to drive more users from Vector to OP, clearly outlining what differentiates OP so orgs we're converting more orgs like like Instacart, Zendesk, Discover, etc who are/were using Vector looks at and buys OP

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@barieom I think @dsmith3197 is asking if we should have the OP footer link directly to the OP product page and not whether we want to have the OP footer or not (I misread it too, until just now).

Copy link
Contributor

@barieom barieom Dec 7, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah thanks for the clarification!

Let's link it to /docs/about/what-is-observability-pipelines

It may seem duplicative, but reason being: for Vector users who end up on vector.dev, we want to be explicit about what the differentiators between OP and Vector are, clearly outlining what OP can do what Vector cannot; case in point, Instacart and Zendesk, who are both heavy Vector users, are planning to buy OP because we released the quotas transform and the ability the enforce a quota across all pipeline instances. We need information somewhere on Vector.dev that calls out the difference between the two. The OP product page on Datadog corpsite, on the other hand, is meant to be a general landing page for everyone, which includes many prospects who've never heard of Vector before

For example, see the last page of these two marketing product briefs: general OP product marketing brief, which we share with most prospects and OP product marketing brief comparing Vector vs OP, which we only share with prospects using Vector already

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dsmith3197 does that work for you?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, that makes sense given the different purposes. Thank you for clarifying @barieom.


[[languages.en.menus.footer]]
name = "Contact us"
url = "/community"
parent = "about"
weight = 2
weight = 3

[[languages.en.menus.footer]]
name = "Privacy"
url = "https://www.datadoghq.com/legal/privacy/"
parent = "about"
weight = 3
weight = 4

[[languages.en.menus.footer]]
name = "Cookies"
url = "https://www.datadoghq.com/legal/cookies/"
parent = "about"
weight = 4
weight = 5

[[languages.en.menus.footer]]
name = "Components"
Expand Down
4 changes: 2 additions & 2 deletions website/content/en/docs/about/concepts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Concepts
weight: 2
weight: 3
tags: ["concepts", "meta", "events", "logs", "metrics", "components", "sources", "transforms", "sinks", "pipeline", "roles", "agent", "aggregator", "topology"]
---

Expand All @@ -26,7 +26,7 @@ A **metric** event represents a numerical operation performed on a time series.

### Traces

A **trace** event can be thought of as a special kind of log event. As of this writing, the components that support trace events are: the `datadog_agent` source, the `datadog_traces` sink, and the `sample` and `remap` transforms.
A **trace** event can be thought of as a special kind of log event. The components that support trace events are: the `datadog_agent` source, the `datadog_traces` sink, and the `sample` and `remap` transforms. **Note**: Support for traces is limited and is in alpha.

If you're interested in using traces with a Vector component that doesn't yet support them, please open an issue so we can have a better understanding of what components to prioritize adding trace support for.

Expand Down
20 changes: 20 additions & 0 deletions website/content/en/docs/about/what-is-observability-pipelines.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: What is Observability Pipelines?
weight: 2
tags: ["concepts"]
---

Observability Pipelines is a commercial observability data pipeline for collecting, processing, and routing observability data from any source to any destination in the infrastructure that you own or manage.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Observability Pipelines is a commercial observability data pipeline for collecting, processing, and routing observability data from any source to any destination in the infrastructure that you own or manage.
Observability Pipelines is a commercial observability data pipeline from Datadog for collecting, processing, and routing observability data from any source to any destination in the infrastructure that you own or manage.

I think this could make it clearer that this is a Datadog product.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! I updated it to Datadog's Observability Pipelines.


Use Observability Pipelines to:

- Manage your pipelines from a control plane. You can build or edit pipelines, whether it is to route a subset of data to a new destination or introduce a new sensitive data redaction rule, and roll out these changes to your active pipelines from the Datadog UI.
- Monitor your pipelines to understand the health of your pipelines, identify bottlenecks and latencies, fine-tune performance, validate data delivery, and investigate your largest volume contributors.
- Better optimize volume and control costs by enforcing quotas, store noisy logs in an archive, and more.
- Scan for and redact sensitive data flowing through your pipelines.

## Learn more

- [Observability Pipelines Overview](https://www.datadoghq.com/product/observability-pipelines/)
- [Take Control of Your Telemetry Data with Datadog Observability Pipelines](https://www.datadoghq.com/blog/datadog-observability-pipelines/)
- [Observability Pipelines documentation](https://docs.datadoghq.com/observability_pipelines/)
5 changes: 5 additions & 0 deletions website/content/en/docs/setup/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,8 @@ In order to cover as many observability use cases as possible, we've built Vecto
Vector is built to be deployable in multiple roles and topologies:

{{< jump "/docs/setup/deployment" >}}

## Download Observability Pipelines

[Observability Pipelines](https://www.datadoghq.com/product/observability-pipelines/) is a commercial aggregator pipeline.

maycmlee marked this conversation as resolved.
Show resolved Hide resolved
Loading