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

[DOCS-7217/7054] Add OP landing and setup docs #22171

Merged
merged 91 commits into from
Apr 11, 2024

Conversation

maycmlee
Copy link
Contributor

@maycmlee maycmlee commented Mar 12, 2024

What does this PR do? What is the motivation?

  • Adds set up docs for use cases and the available sources
  • Adds the Observability Pipelines landing page
  • Adds general reuse shortcodes.
  • Updates the OP sections of the remote config docs to say "public beta".
  • Pulls in part of the Architecture doc that is is in the current docs
  • Adds nav items

Merged into base branch's PR: #21974

Merge instructions

  • Please merge after reviewing

Additional notes

@maycmlee maycmlee added the WORK IN PROGRESS No review needed, it's a wip ;) label Mar 12, 2024
@maycmlee maycmlee requested a review from a team as a code owner March 12, 2024 20:59
@github-actions github-actions bot added the Architecture Everything related to the Doc backend label Mar 12, 2024
Copy link
Contributor

github-actions bot commented Mar 12, 2024

Preview links (active after the build_preview check completes)

New or renamed files

Modified Files

@maycmlee maycmlee changed the title [DOCS-7217/7054] Add OP use case docs [DOCS-7217/7054] Add OP landing and use case docs Mar 12, 2024
maycmlee and others added 4 commits April 9, 2024 13:07
* add doc

* small edits

* add source env vars shortcode and update doc

* update overview

* update shortcode content

* update shortcodes

* small edit

* fix link

* Apply suggestions from code review

Co-authored-by: Jen Gilbert <[email protected]>

* Update layouts/shortcodes/observability_pipelines/configure_existing_pipelines/destination_env_vars/sumo_logic.md

Co-authored-by: Jen Gilbert <[email protected]>

* fix amazon eks shortcode

* uppercase placeholders

* small edits and fixes

---------

Co-authored-by: Jen Gilbert <[email protected]>
@github-actions github-actions bot added the Images Images are added/removed with this PR label Apr 10, 2024

As your infrastructure and applications grow, so does your log volume and the complexity of the data. A large volume of logs can introduce a lot of noise and make it difficult to analyze and troubleshoot logs. Use Observability Pipelines's processors to decide which logs are valuable and which ones are noisy and uninteresting, before sending your logs to their destinations. You can use the following processors in the Observability Pipeline Worker to manage your logs:

- Filter: Add a query to send only a subset of logs based on your conditions.
Copy link
Contributor

Choose a reason for hiding this comment

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

Should this be highlighted a little bit more? Maybe a bold font?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Bolded


- Filter: Add a query to send only a subset of logs based on your conditions.
- Sample: Define a sampling rate to send only a subset of your logs.
- Quota: Enforce soft or hard daily limits on either the volume of log data or the number of log events.
Copy link
Contributor

Choose a reason for hiding this comment

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

What does "soft or hard" mean here? Perhaps it would be simpler to just say "daily limits".

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Removed "soft and hard"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hi @pront! I think Barry was referring to soft quotas where you'd set up a monitor to alert you but don't do anything to the data ingested after the limit. See: https://docs.datadoghq.com/observability_pipelines/guide/set_quotas_for_data_sent_to_a_destination/#overview:~:text=You%20can%20also,to%20another%20destination.

You can also use multiple quota transforms to set different warning and alert limits. For example, use the first quota transform to set a limit at a warning level and send a warning notification when the limit is reached. Then, use a second quota transform to set a hard limit. When the hard limit is reached, you can send out an alert notification and start sampling the data sent after the limit or reroute that data to another destination.

But let's keep it simple for now. We can add that information in later. Thanks!


As your infrastructure and applications grow, so does your log volume and the complexity of the data. A large volume of logs can introduce a lot of noise and make it difficult to analyze and troubleshoot logs. Use Observability Pipelines's processors to decide which logs are valuable and which ones are noisy and uninteresting, before sending your logs to their destinations. You can use the following processors in the Observability Pipeline Worker to manage your logs:

- Filter: Add a query to send only a subset of logs based on your conditions.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Bolded


- Filter: Add a query to send only a subset of logs based on your conditions.
- Sample: Define a sampling rate to send only a subset of your logs.
- Quota: Enforce soft or hard daily limits on either the volume of log data or the number of log events.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Removed "soft and hard"

@maycmlee maycmlee merged commit c3039a4 into may/obs-pipelines-2.0 Apr 11, 2024
9 of 10 checks passed
@maycmlee maycmlee deleted the may/op-2.0-use-cases branch April 11, 2024 13:02
jhgilbert added a commit that referenced this pull request Apr 18, 2024
* hide legacy docs

* fix typo

* update legacy doc links to legacy docs

* add legacy to titles

* fix dupe

* add legacy to config title

* add legacy param (#22130)

* [PRODUCTSA-1093] Refine K8S Helm chart values (#21811)

* add alert

* add aliases

* remove alias for monitoring

* add warning to pages

* Update content/en/observability_pipelines/legacy/_index.md

Co-authored-by: Esther Kim <[email protected]>

* [DOCS-7217/7054]  Add OP landing and setup docs (#22171)

* add dual ship splunk

* add destination variables and other edits

* updates

* add content

* add more installation content

* fix typos

* another typo

* add landing page

* add update existing pipelines

* add existing doc as separate doc

* small edits

* update to configure existing pipelines

* add migration note

* edit processor

* add docker example

* small edit

* update existing pipelines

* move configure existing to separate pr

* updates

* reorder nav and small edits

* update redaction

* update landing page

* small edits include rc update

* update filenames

* add datadog

* add use case indexes

* small edits

* update landing pages

* add architecture

* edits to landing pages

* move datadog to top

* add reuse shortcode files

* add all nav items

* add splunk hec pages

* update nav and titles and more

* more updates to names

* add prereqs, source settings, desintation settings shortcodes

* add processors

* add worker installation shortcodes

* add log source config shortcodes

* remove old splunck hec doc

* add archive log shortcodes

* add sds and datadog archives

* update prereqs

* update shortcodes

* add upgrade div and legacy warning shortcodes

* add processors shortcode

* splunk tcp docs

* fix links

* really fix all shortcode links

* update all splunk tcp docs

* add archives dest tcp

* add sumo logic docs

* fix sumo logic docs

* add datadog agent docs

* make titles consistent

* consistency edits

* add dd overviews

* add cloudformation table

* fix landing page links

* add path notation example

* small fix

* add splt logs prereqs tabs

* add gov note

* small edits

* small edits

* small edits

* Apply suggestions from code review

Co-authored-by: Jen Gilbert <[email protected]>

* Apply suggestions from code review

Co-authored-by: Jen Gilbert <[email protected]>

* capitalize placeholders and small edits

* Update content/en/observability_pipelines/_index.md

Co-authored-by: Jen Gilbert <[email protected]>

* [DOCS-7432] Configure existing pipelines for OP (#22205)

* add doc

* small edits

* add source env vars shortcode and update doc

* update overview

* update shortcode content

* update shortcodes

* small edit

* fix link

* Apply suggestions from code review

Co-authored-by: Jen Gilbert <[email protected]>

* Update layouts/shortcodes/observability_pipelines/configure_existing_pipelines/destination_env_vars/sumo_logic.md

Co-authored-by: Jen Gilbert <[email protected]>

* fix amazon eks shortcode

* uppercase placeholders

* small edits and fixes

---------

Co-authored-by: Jen Gilbert <[email protected]>

* remove sources list and add further reading to landing

* add split logs images

* add alt text and general proc image

* try to fix image

* try again to fix

* desperately try to fix images

* add images to md

* add images

* update images

* remap to edit fields

* remove datadog tab from destination env var

* make us1-fed note red

* cloudformation contact support

* update config existing pipelines title and add links to that doc

* update nav and architecture nav, title, and filename

* Update content/en/observability_pipelines/log_volume_control/_index.md

---------

Co-authored-by: Jen Gilbert <[email protected]>

* add marketecture image

* fix best practices filename and nav link

* small edits

* add aliases for monitoring, architecture, and troubleshooting legacy docs

* Correct prettier issue

* Fix indent

---------

Co-authored-by: StefonSimmons <[email protected]>
Co-authored-by: eugene kirillov <[email protected]>
Co-authored-by: Esther Kim <[email protected]>
Co-authored-by: Brian Deutsch <[email protected]>
Co-authored-by: Jen Gilbert <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Architecture Everything related to the Doc backend Images Images are added/removed with this PR WORK IN PROGRESS No review needed, it's a wip ;)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants