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

Updates Data Prepper use-case images #3844

Merged

Conversation

dlvenable
Copy link
Member

@dlvenable dlvenable commented Apr 25, 2023

Description

This PR updates the images used for Data Prepper use-cases:

  • Updated icon for Data Prepper
  • Use Open Sans font
  • Makes use of OpenSearch style guide for colors
  • Use JPEG files for compression

Issues Resolved

N/A

Checklist

  • By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
    For more information on following Developer Certificate of Origin and signing off your commits, please check here.

… OpenSearch icons and typography.

Signed-off-by: David Venable <[email protected]>
Copy link
Contributor

@cwillum cwillum left a comment

Choose a reason for hiding this comment

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

LGTM

@Naarcha-AWS Naarcha-AWS merged commit 3baac55 into opensearch-project:main Apr 27, 2023
@Naarcha-AWS Naarcha-AWS added backport 2.5 PR: Backport label for 2.5 backport 2.6 PR: Backport label for 2.6 labels Apr 27, 2023
opensearch-trigger-bot bot pushed a commit that referenced this pull request Apr 27, 2023
… OpenSearch icons and typography. (#3844)

Signed-off-by: David Venable <[email protected]>
(cherry picked from commit 3baac55)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
opensearch-trigger-bot bot pushed a commit that referenced this pull request Apr 27, 2023
… OpenSearch icons and typography. (#3844)

Signed-off-by: David Venable <[email protected]>
(cherry picked from commit 3baac55)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Naarcha-AWS pushed a commit that referenced this pull request Apr 27, 2023
… OpenSearch icons and typography. (#3844) (#3896)

(cherry picked from commit 3baac55)

Signed-off-by: David Venable <[email protected]>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Naarcha-AWS pushed a commit that referenced this pull request Apr 27, 2023
… OpenSearch icons and typography. (#3844) (#3895)

(cherry picked from commit 3baac55)

Signed-off-by: David Venable <[email protected]>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Copy link
Contributor

@hdhalter hdhalter left a comment

Choose a reason for hiding this comment

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

Other than a few nits, looks good!

@@ -15,7 +15,7 @@ When using Data Prepper as a server-side component to collect trace data, you ca

The following flowchart illustrates the trace analytics workflow, from running OpenTelemetry Collector to using OpenSearch Dashboards for visualization.

<img src="{{site.url}}{{site.baseurl}}/images/data-prepper/trace-analytics/trace-analytics-components.png" alt="Trace analyticis component overview">{: .img-fluid}
<img src="{{site.url}}{{site.baseurl}}/images/data-prepper/trace-analytics/trace-analytics-components.jpg" alt="Trace analyticis component overview">{: .img-fluid}
Copy link
Contributor

Choose a reason for hiding this comment

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

alt="Trace analyticis --> alt="Trace analytics"

@@ -27,7 +27,7 @@ To monitor trace analytics, you need to set up the following components in your

To monitor trace analytics in Data Prepper, we provide three pipelines: `entry-pipeline`, `raw-trace-pipeline`, and `service-map-pipeline`. The following image provides an overview of how the pipelines work together to monitor trace analytics.
Copy link
Contributor

Choose a reason for hiding this comment

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

Data Prepper provides three pipelines that can be used to monitor trace analytics:

@@ -11,15 +11,15 @@ Data Prepper is an extendable, configurable, and scalable solution for log inges

The following image shows all of the components used for log analytics with Fluent Bit, Data Prepper, and OpenSearch.

![Log analytics component]({{site.url}}{{site.baseurl}}/images/data-prepper/log-analytics/log-analytics-components.png)
![Log analytics component]({{site.url}}{{site.baseurl}}/images/data-prepper/log-analytics/log-analytics-components.jpg)

In the application environment, run Fluent Bit. Fluent Bit can be containerized through Kubernetes, Docker, or Amazon Elastic Container Service (Amazon ECS). You can also run Fluent Bit as an agent on Amazon Elastic Compute Cloud (Amazon EC2). Configure the [Fluent Bit http output plugin](https://docs.fluentbit.io/manual/pipeline/outputs/http) to export log data to Data Prepper. Then deploy Data Prepper as an intermediate component and configure it to send the enriched log data to your OpenSearch cluster. From there, use OpenSearch Dashboards to perform more intensive visualization and analysis.
Copy link
Contributor

Choose a reason for hiding this comment

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

I know I'm not obligated to review this, but I just wonder if we can start this sentence with some kind of intro to what they are doing? Like, "To get started using log analytics in Data Prepper, run Fluent Bit in the application environment of your choice. ... Also, the sentence with "Then..." should have a better starter phrase, like, "After configuring Fluent Bit, deploy Data Prepper..." (The paragraph seems a bit rushed.)

@@ -11,15 +11,15 @@ Data Prepper is an extendable, configurable, and scalable solution for log inges

The following image shows all of the components used for log analytics with Fluent Bit, Data Prepper, and OpenSearch.

![Log analytics component]({{site.url}}{{site.baseurl}}/images/data-prepper/log-analytics/log-analytics-components.png)
![Log analytics component]({{site.url}}{{site.baseurl}}/images/data-prepper/log-analytics/log-analytics-components.jpg)

In the application environment, run Fluent Bit. Fluent Bit can be containerized through Kubernetes, Docker, or Amazon Elastic Container Service (Amazon ECS). You can also run Fluent Bit as an agent on Amazon Elastic Compute Cloud (Amazon EC2). Configure the [Fluent Bit http output plugin](https://docs.fluentbit.io/manual/pipeline/outputs/http) to export log data to Data Prepper. Then deploy Data Prepper as an intermediate component and configure it to send the enriched log data to your OpenSearch cluster. From there, use OpenSearch Dashboards to perform more intensive visualization and analysis.

## Log analytics pipeline
Copy link
Contributor

Choose a reason for hiding this comment

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

Should it be Log analytics pipelines?

@@ -15,7 +15,7 @@ When using Data Prepper as a server-side component to collect trace data, you ca

The following flowchart illustrates the trace analytics workflow, from running OpenTelemetry Collector to using OpenSearch Dashboards for visualization.

<img src="{{site.url}}{{site.baseurl}}/images/data-prepper/trace-analytics/trace-analytics-components.png" alt="Trace analyticis component overview">{: .img-fluid}
<img src="{{site.url}}{{site.baseurl}}/images/data-prepper/trace-analytics/trace-analytics-components.jpg" alt="Trace analyticis component overview">{: .img-fluid}

To monitor trace analytics, you need to set up the following components in your service environment:
Copy link
Contributor

Choose a reason for hiding this comment

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

To monitor trace analytics, you need to set up the --> To monitor trace analytics, set up

Copy link
Collaborator

@kolchfa-aws kolchfa-aws left a comment

Choose a reason for hiding this comment

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

LGTM

vagimeli pushed a commit that referenced this pull request May 4, 2023
… OpenSearch icons and typography. (#3844)

Signed-off-by: David Venable <[email protected]>
vagimeli added a commit that referenced this pull request May 4, 2023
…ges with OpenSearch icons and typography. (#3844)"

This reverts commit 9ceab84.
@dlvenable dlvenable deleted the data-prepper-image-refresh branch August 21, 2023 16:45
harshavamsi pushed a commit to harshavamsi/documentation-website that referenced this pull request Oct 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport 2.5 PR: Backport label for 2.5 backport 2.6 PR: Backport label for 2.6
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants