From 49fbaf30d95576afa53ed34a63acf1fe87fd9732 Mon Sep 17 00:00:00 2001 From: John Pipkin Date: Mon, 1 Dec 2025 15:51:42 -0600 Subject: [PATCH] Update image tagging in APM files --- blog-service/2023/12-31.md | 3 +- .../real-user-monitoring/browser-traces.md | 4 +- .../configure-data-collection.md | 2 +- docs/apm/real-user-monitoring/dashboards.md | 20 +++---- docs/apm/real-user-monitoring/metrics.md | 2 +- docs/apm/spans.md | 32 +++++------ .../filter-shape-tracing-data.md | 4 +- .../working-with-span-attributes.md | 4 +- .../http-traces-source.md | 2 +- .../opentelemetry-instrumentation/istio.md | 8 ++- ...t-up-traces-collection-aws-environments.md | 16 +++--- ...races-collection-for-other-environments.md | 4 +- ...earch-query-language-support-for-traces.md | 12 ++-- docs/apm/traces/tracing-dashboards.md | 44 +++++++-------- .../apm/traces/view-and-investigate-traces.md | 55 +++++++++---------- .../automation-service-bridge.md | 2 +- docs/reuse/apps/create-aws-s3-source.md | 2 +- docs/reuse/aws-cost-explorer.md | 2 +- docs/reuse/contributing/submit.md | 10 ++-- 19 files changed, 121 insertions(+), 107 deletions(-) diff --git a/blog-service/2023/12-31.md b/blog-service/2023/12-31.md index 8b2b2c9141..c70edecc88 100644 --- a/blog-service/2023/12-31.md +++ b/blog-service/2023/12-31.md @@ -121,8 +121,7 @@ We’re excited to announce that we've updated the Sumo Logic Kubernetes Helm Ch To learn more, see [Set up Data Collection for Kubernetes](/docs/observability/kubernetes/collection-setup) and the diagram below, which distinguishes support available on Falco for collection and enrichment. -![K8s.png](/img/kubernetes/K8s-architecture.png) - +Kubernetes architecture --- ### October 18, 2023 (Apps) diff --git a/docs/apm/real-user-monitoring/browser-traces.md b/docs/apm/real-user-monitoring/browser-traces.md index 59eb470f4f..dd22498467 100644 --- a/docs/apm/real-user-monitoring/browser-traces.md +++ b/docs/apm/real-user-monitoring/browser-traces.md @@ -4,6 +4,8 @@ title: Search RUM Browser Traces sidebar_label: RUM Browser Traces --- +import useBaseUrl from '@docusaurus/useBaseUrl'; + To collect browser RUM traces, create a [trace query](/docs/apm/traces/view-and-investigate-traces) that specifies traces starting with the value you gave to `` as a root service name. You can also include the following filters as an operation name: * `documentLoad` as an operation name to find traces that correspond to page loads. * `Click on *` as an operation name to detect click actions that most likely resulted in XHR calls @@ -11,4 +13,4 @@ To collect browser RUM traces, create a [trace query](/docs/apm/traces/view-and- Click on any of the load spans, such as `documentLoad`, `documentFetch`, or `resourceFetch` (for `documentLoad`), to open a right-side panel with detailed span metadata, including timing events. -![RUM-trace-view with border.png](/img/rum/RUM-trace-view-with-border.png) +RUM trace view with border diff --git a/docs/apm/real-user-monitoring/configure-data-collection.md b/docs/apm/real-user-monitoring/configure-data-collection.md index edd739b6b5..10c21e792c 100644 --- a/docs/apm/real-user-monitoring/configure-data-collection.md +++ b/docs/apm/real-user-monitoring/configure-data-collection.md @@ -102,7 +102,7 @@ This can be also replaced with an internal OpenTelemetry collector if you wish t Use the copied script in your page head inside the `` `` tags. The script sends trace data in [OTLP/JSON over HTTP](https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/protocol/otlp.md#otlphttp) protocol.  :::tip -You can view and copy a script anytime by clicking **Show script** for the source.
![show-script.png](/img/rum/show-script.png) +You can view and copy a script anytime by clicking **Show script** for the source.
Show script ::: The following are base script examples, populated when you create and configure a source in the above instructions. diff --git a/docs/apm/real-user-monitoring/dashboards.md b/docs/apm/real-user-monitoring/dashboards.md index 2499fedcc0..3d4b2fe7b8 100644 --- a/docs/apm/real-user-monitoring/dashboards.md +++ b/docs/apm/real-user-monitoring/dashboards.md @@ -36,7 +36,7 @@ import AppUninstall from '../../reuse/apps/app-uninstall.md'; Once the RUM app has been installed, use the Real User Monitoring view to gain visibility into your web app's performance and end-user activity, such as geographic location, browser type, operating systems used. These dashboards visualize RUM metrics gathered from browser tracing instrumentation. 1. [**New UI**](/docs/get-started/sumo-logic-ui). In the main Sumo Logic menu, select **Observability**, and then under **Real User Monitoring**, select **User Experience**. You can also click the **Go To...** menu at the top of the screen and select **User Experience**.
[**Classic UI**](/docs/get-started/sumo-logic-ui-classic). Go to the **Home** screen and select **Explore**. Then in the upper-left corner of the screen, select **Real User Monitoring** from the dropdown menu. -1. Select your desired dashboard from **Dashboard** dropdown menu in the header:
![explore rum with red box.png](/img/rum/explore-rum-with-red-box.png)
There are three dashboard types on the **Application**, **Service**, and **Environment** levels, and a single one on the **Action type** and **Action** levels. +1. Select your desired dashboard from **Dashboard** dropdown menu in the header:
Explore RUM with red box
There are three dashboard types on the **Application**, **Service**, and **Environment** levels, and a single one on the **Action type** and **Action** levels. 1. Set your desired filters. RUM data is organized on five levels: * **Application**. corresponds to the value of the application tag set in your [RUM script](/docs/apm/real-user-monitoring/configure-data-collection/#step-2-add-rum-script-to-your-page-header). This should correspond to your whole website defined by its business function, such as `the-coffee-bar-app`. * **Service**. corresponds to the name of the service in your [RUM script](/docs/apm/real-user-monitoring/configure-data-collection/#step-2-add-rum-script-to-your-page-header). The value should correspond to the JavaScript code executed in your browser, such as `coffee-bar-frontend`. You can have multiple services for each application. @@ -47,7 +47,7 @@ Once the RUM app has been installed, use the Real User Monitoring view to gain v * **route changes**. Single-page-app specific way to navigate to a new page/view without having to load a new document. * **Action Name**. Automatically generated from URLs. No configuration is required. The specifics of it will depend on action type. Action names can contain asterisks (`*`) to replace automatically-detected dynamic parts of the URL. If you have action names that overlap, the action name with an asterisk contains data for page loads NOT contained in more specific action names. For example, `http://www.site.com/path/page.htm` does not contain actions from `http://www.site.com/path/*`. -Example:
Real User Monitoring Load Action Dashboard +Example:
Real User Monitoring Load Action Dashboard ## Navigating RUM Dashboards @@ -67,9 +67,9 @@ You can also click on any data-point on the charts to open a details panel and v Overview dashboards on all view levels have a panel showing geographical user activity for the selected entity. Geographic dashboards measure user activity as dot size and performance as a color. -![RUM Overview dashboard](/img/rum/RUM-Overview.png) +RUM Overview dashboard -![RUM Overview Application and RUM Overview Service dashboards](/img/rum/RUM-Overview-Application-Service.png) +RUM Overview Application and RUM Overview Service dashboards ### RUM TopN Application/Service @@ -83,7 +83,7 @@ Use these dashboards to: You can select the timing metric type in the **statistic** dropdown on the dashboard header. This will change the browser time metrics types on charts. You can also define the top N number for all charts. -![RUM TopN Application and RUM TopN Service dashboards](/img/rum/RUM-TopN-Application.png) +RUM TopN Application and RUM TopN Service dashboards ### RUM Performance Analytics Application/Service @@ -96,7 +96,7 @@ Use these dashboards to: You can click on any data point on the charts to open a details panel and view the **Infrastructure** tab to drill-down to traces representing user transactions from the selected time point. For cross-dimensional metrics, only the average statistic type is available. -![RUM-Performance-Analytics-Application dashboard](/img/rum/RUM-Performance-Analytics-Application.png) +RUM Performance Analytics Application dashboard ## Collecting Browser Errors @@ -113,7 +113,7 @@ Browser error logs, although collected via RUM script, contribute to your log Co Data in the index is query-able using normal log search query. Here’s a sample query and results: -Sumo Logic log search displaying error logs filtered by the operation 'click on Pay' +Sumo Logic log search displaying error logs filtered by the operation 'click on Pay' The following fields are available to better aggregate and filter your results: * Application @@ -130,10 +130,10 @@ Because errors do not always have to be connected with user actions, it is ok to In addition to that, we also aggregate that information in form of log-query based panels and display on various dashboards: -Real User Monitoring log errors per second graphic +Real User Monitoring log errors per second graphic -Real User Monitoring log errors XHR per second graphic +Real User Monitoring log errors XHR per second graphic -Real User Monitoring log errors by browser, operating system, and geolocations graphic +Real User Monitoring log errors by browser, operating system, and geolocations graphic Logs collection is enabled by default. You can disable by setting `collectErrors=false` in your RUM script options. diff --git a/docs/apm/real-user-monitoring/metrics.md b/docs/apm/real-user-monitoring/metrics.md index 5182d9f244..e2e18b5179 100644 --- a/docs/apm/real-user-monitoring/metrics.md +++ b/docs/apm/real-user-monitoring/metrics.md @@ -21,7 +21,7 @@ The following document load metrics are collected from JavaScript. These are ava These metrics, presented in the form of areas on the **Website Performance** panels on [RUM dashboards](/docs/apm/real-user-monitoring/dashboards), can help you understand the sequence of events (pictured below) from user clicks to a fully loaded document. -![Diagram showing various navigation metrics from user clicks to a fully loaded document, including DNS resolution, SSL connection, TCP establishment, request end, first byte, response end, interactive time, and processing end](/img/rum/Navigation-metrics.png) +Document load metrics Timing metrics are not calculated if the visibility state of the document is "hidden" at any point during the load. diff --git a/docs/apm/spans.md b/docs/apm/spans.md index 2d39fd78ce..cd45a5f264 100644 --- a/docs/apm/spans.md +++ b/docs/apm/spans.md @@ -19,7 +19,7 @@ To access span analytics: A new **Spans** page opens. Data is displayed once you run a query. -![Spans page](/img/apm/spans-page.png) +Spans page From here, you can filter and aggregate by any standard or custom span attribute (tag) and create charts to visualize results. If you find something interesting, you can quickly explore your raw span records in the **Messages** tab. @@ -54,11 +54,11 @@ This micro lesson provides an overview of Span Analytics, and describes the term You can build a spans query using the provided input fields. By default, you'll see an input for **Filters** and **Visualize**. -![blank spans query](/img/apm/spans-query-blank.png) +Blank spans query Once you click the text area of an input field, you'll get a dropdown menu that provides the available options detected from your data. You can manually type into these input fields or select from the dropdown of available options. -![dropdown for spans filter](/img/apm/dropdown-for-spans-filter.png) +Dropdown for spans filter ### Filters @@ -90,7 +90,7 @@ If you define **Visualize**, an option to set **Group By** appears, allowing If you define **Group By**, you'll see another option to set a **Limit** value. This allows you to reduce the number of results by an order. -![spans query](/img/apm/spans-query.png) +Spans query :::note When you run a query using **Visualize** and/or **Group By**, the results tab automatically switches to **Aggregates**. @@ -106,11 +106,11 @@ You set the time range of the query at the top right of the Spans page, above th Once you have defined your spans query, with filters and aggregation if desired, click the search button to run the search. It looks like the following: -![spans search button](/img/apm/spans-search-button.png) +Spans search button You can pause or stop your search by clicking the appropriate icons below the search button. -![pause or stop spans query](/img/apm/pause-or-stop-spans-query.png) +Pause or stop spans quer ## Search results @@ -120,10 +120,10 @@ You can pause or stop your search by clicking the appropriate icons below the se The **Messages** table shows your raw span data. You can click on any row to open a right-side Details pane (similar to the one in [Trace View](/docs/apm/traces/view-and-investigate-traces)) showing span details and options to navigate to other parts of the system from there. -![messages results](/img/apm/spans-messages-results.png) +Messages results * To move a column left or right, hold click and drag it to a different location in the table. -* To adjust column width, click and drag the vertical line in between the columns.
![resize column](/img/search/get-started-search/search-page/resize-column.png) +* To adjust column width, click and drag the vertical line in between the columns.
Resize column * To reset column width to the default size, double-click the vertical line to the right of a column name. #### Facets @@ -132,20 +132,20 @@ The **Facets** panel provides a list of all the metadata fields returned from yo The content of the Facets panel is affected by your current active filters and time range, but shows any found metadata tag (span attribute) with its top 10 values, including any custom tags you may [add to your data](/docs/apm/traces/get-started-transaction-tracing/opentelemetry-instrumentation/java/custom-tags-configuration). By default, the fields used in the query are shown in the Messages table. -![Facets expanded](/img/apm/facets-expanded.png) +Facets expanded * You can adjust which fields are displayed in the raw span messages table by checking or unchecking the box next to the field in the Facets panel. * Use the search field to easily find the metadata from your data. This applies the filter to both tag names and their values. * The number of values found for each is displayed for your reference. * Add and remove fields from your query by hovering over a field and clicking. -![facets add to query](/img/apm/facets-add-to-query.png) +Facets add to query ### Aggregates tab The **Aggregates** tab shows your data charted. See Panels from Dashboard for details on the settings. However, note that not all settings will be available on the Spans page. The interface will only show you available settings. -![spans-aggregates-visualize](/img/apm/spans-aggregates-visualize.png) +<your image description> #### Add to Dashboard @@ -153,15 +153,15 @@ You can add to a dashboard as long as your total dashboard-originated `_trace_sp To add your aggregated span data to a dashboard: -1. Click the three-dot kebab menu icon and select **Add to Dashboard**.
![add-to-dashboard-spans](/img/apm/spans-add-to-dashboard.png) -1. In the **Add Panel to Dashboard** window, provide a **Panel Title** and enter an existing **Dashboard** name or add to a newly created a new one, as seen in this screenshot.
![span-dashboard](/img/apm/span-dashboard.png) +1. Click the three-dot kebab menu icon and select **Add to Dashboard**.
Add to dashboard spans +1. In the **Add Panel to Dashboard** window, provide a **Panel Title** and enter an existing **Dashboard** name or add to a newly created a new one, as seen in this screenshot.
Span dashboard 1. When you're done assigning the panel to a dashboard, click **Add**. #### Open in Search To further enhance your query, you can use the [Search Query Language](/docs/apm/traces/search-query-language-support-for-traces) for more advanced use cases by opening a Search of your spans. Click the three-dot kebab menu icon and select **Open in Search**. -![span-open-in-search](/img/apm/span-open-in-search.png) +Span open in search ### Examples @@ -171,7 +171,7 @@ To compare the performance of different release versions defined by a custom tag Use the **filters** or **facets** features to find the appropriate service in the dropdown and select it. Next, select to visualize duration’s 95th percentile and pick a group by time. For example, 1-minute granularity and the `assemblyVersion` custom tag that carries version information. That’s it! -![service percentile by time](/img/apm/service-percentile-by-time.png) +Service percentile by time You can customize your chart by picking different visualization types and colors. @@ -181,7 +181,7 @@ Next, let’s see how to find the distribution of different HTTP errors among ou Here is the simple query we used to visualize that data: -![status codes spans example](/img/apm/spans-status-codes-example.png) +Status codes spans example It’s now easier than ever to drill down into the information you care about. Note that our query only includes spans with codes from 4xx and 5xx ranges and visualizes the count of such spans, broken down by two dimensions, service and status code. Easy! diff --git a/docs/apm/traces/advanced-configuration/filter-shape-tracing-data.md b/docs/apm/traces/advanced-configuration/filter-shape-tracing-data.md index 46b42a08c0..02afb754ab 100644 --- a/docs/apm/traces/advanced-configuration/filter-shape-tracing-data.md +++ b/docs/apm/traces/advanced-configuration/filter-shape-tracing-data.md @@ -5,6 +5,8 @@ sidebar_label: Filter and Shape Output Data description: Learn how to create and apply custom rules to shape tracing data. --- +import useBaseUrl from '@docusaurus/useBaseUrl'; + You may ask yourself, "What if I do not want to send all my trace data to Sumo Logic?". With our OpenTelemetry collector, you can define custom rules to filter and extract data based on your selection. Our OpenTelemetry collector is uniquely capable of [shaping trace data at output](https://github.com/SumoLogic/sumologic-otel-collector/tree/main/pkg/processor/cascadingfilterprocessor). You can define rules in a cascading fashion, assign different volume pool sizes to each rule, and give them different priorities. @@ -15,7 +17,7 @@ Output-level filtering ensures you will always have valuable, useful, and cost-o For best results, perform filtering on a central instance of Aggregating OpenTelemetry Collector (see the following diagram), as it gives possibilities to act on whole trace, rather than individual span level. -![env multiple agents bd.png](/img/apm/traces/env-multiple-agents-bd.png) +Environment with multiple agents The aggregating collector can receive data from local collectors/agents or directly from the tracing client. diff --git a/docs/apm/traces/advanced-configuration/working-with-span-attributes.md b/docs/apm/traces/advanced-configuration/working-with-span-attributes.md index 5b46024531..547a1d5d41 100644 --- a/docs/apm/traces/advanced-configuration/working-with-span-attributes.md +++ b/docs/apm/traces/advanced-configuration/working-with-span-attributes.md @@ -4,6 +4,8 @@ title: Working with Span Attributes description: Learn how to modify the attributes of your spans. --- +import useBaseUrl from '@docusaurus/useBaseUrl'; + You can add, delete, hash, or modify span attributes (metadata tags) on Collectors or directly in your application code. This helps you enhance diagnostic details included in your data, remove redundant information to cut the cost, or mask sensitive information before they leave your site. ## Attach logs to spans @@ -19,7 +21,7 @@ You can collect logs with traces attached to them by [inserting `spanid` and `t and they are displayed in the **Span logs** tab in [Details Pane](/docs/apm/traces/view-and-investigate-traces) after clicking on the span. -![span logs in details pane.png](/img/apm/span-logs-in-details-pane.png) +Span logs in details pane ## Working with attributes on OpenTelemetry collector diff --git a/docs/apm/traces/get-started-transaction-tracing/http-traces-source.md b/docs/apm/traces/get-started-transaction-tracing/http-traces-source.md index a91c7931ec..efd21b5fbb 100644 --- a/docs/apm/traces/get-started-transaction-tracing/http-traces-source.md +++ b/docs/apm/traces/get-started-transaction-tracing/http-traces-source.md @@ -29,7 +29,7 @@ To configure an HTTP Traces Source: ## View the endpoint URL -If you need to access the Source's URL again, click **Show URL**.
![show url traces.png](/img/apm/traces/show-url-traces.png) +If you need to access the Source's URL again, click **Show URL**.
Show URL traces ## Send a test trace to Sumo diff --git a/docs/apm/traces/get-started-transaction-tracing/opentelemetry-instrumentation/istio.md b/docs/apm/traces/get-started-transaction-tracing/opentelemetry-instrumentation/istio.md index f3bb1d89d7..a15d8b33f8 100644 --- a/docs/apm/traces/get-started-transaction-tracing/opentelemetry-instrumentation/istio.md +++ b/docs/apm/traces/get-started-transaction-tracing/opentelemetry-instrumentation/istio.md @@ -5,6 +5,8 @@ sidebar_label: Istio description: Learn how to instrument OpenTelemetry Application code to collect Istio trace data generated from Envoy proxies. --- +import useBaseUrl from '@docusaurus/useBaseUrl'; + OpenTelemetry Collector gives you the ability to collect Istio trace data and forward it to Sumo Logic. [Istio](https://istio.io/latest/) is a popular service mesh technology using Envoy proxy technology that provides out-of-the-box tracing generation from its sidecars. Although its tracing capabilities cannot fully replace visibility that  you can obtain by collecting traces by instrumenting the application code directly, it can provide some additional details to delays introduced by sidecar proxies that will generate its own specific spans. @@ -117,7 +119,7 @@ Every action requires restart of the pods involved in tracing. Example output: - ![istio1.png](/img/apm/traces/istio1.png) + Istio Check if correct values are set for `enableTracing` and `defaultConfig.tracing.EXPORTER_NAME.address`. If OpenCensus was configured, then Zipkin by default points to an Istio endpoint. @@ -127,7 +129,7 @@ Every action requires restart of the pods involved in tracing. kubectl get namespace -L istio-injection ``` - ![istio2.png](/img/apm/traces/istio2.png) + Istio 1. Make sure the `namespace` in which the application is running `istio-injection` label is set as `enabled`. If label value is disabled or not set then run: @@ -143,4 +145,4 @@ Every action requires restart of the pods involved in tracing. Example output: - ![istio3.png](/img/apm/traces/istio3.png) + Istio diff --git a/docs/apm/traces/get-started-transaction-tracing/set-up-traces-collection-aws-environments.md b/docs/apm/traces/get-started-transaction-tracing/set-up-traces-collection-aws-environments.md index b21676803b..074c8949ff 100644 --- a/docs/apm/traces/get-started-transaction-tracing/set-up-traces-collection-aws-environments.md +++ b/docs/apm/traces/get-started-transaction-tracing/set-up-traces-collection-aws-environments.md @@ -5,6 +5,8 @@ sidebar_label: AWS Environment Setup description: To collect traces in non-Kubernetes AWS environments like EC2 or ECS (including Fargate), you can install an OpenTelemetry Collector from the Sumo Logic Distribution for OpenTelemetry. --- +import useBaseUrl from '@docusaurus/useBaseUrl'; + To collect traces in non-Kubernetes AWS environments like EC2 or ECS (including Fargate), you can install the [Sumo Logic Distribution for OpenTelemetry](https://github.com/SumoLogic/sumologic-otel-collector). Collecting telemetry data and sending it to Sumo Logic, the official partner and contributor to the project, has never been easier. ## Prerequisites @@ -67,9 +69,9 @@ You'll need an ECS Cluster where the Sumo Logic Distribution for OpenTelemetry C aws cloudformation create-stack --stack-name sumologic-aws-otel-col-ecs-ec2 --template-body file://${TEMPLATE_PATH} --parameters ParameterKey=ClusterName,ParameterValue=${CLUSTER_NAME} --capabilities=CAPABILITY_NAMED_IAM --region=${AWS_REGION} ``` -1. To check if everything was deployed go to the [CloudFormation Stacks console](https://console.aws.amazon.com/cloudformation/home#/stacks?filteringStatus=active&filteringText=&viewNested=true&hideStacks=false) and check if the **sumologic-aws-otel-col-ecs-ec2** stack status is **CREATE_COMPLETE**.
![stack status.png](/img/apm/traces/stack_status.png) +1. To check if everything was deployed go to the [CloudFormation Stacks console](https://console.aws.amazon.com/cloudformation/home#/stacks?filteringStatus=active&filteringText=&viewNested=true&hideStacks=false) and check if the **sumologic-aws-otel-col-ecs-ec2** stack status is **CREATE_COMPLETE**.
Stack status -1. The next step is to check if your deployment is properly running. Go to the [ECS Console](https://console.aws.amazon.com/ecs/home), select the proper region, and select the cluster you used to deploy the Collector. Navigate to the **Tasks** tab and check if the task is running.
![task status running.png](/img/apm/traces/task-status-running.png) +1. The next step is to check if your deployment is properly running. Go to the [ECS Console](https://console.aws.amazon.com/ecs/home), select the proper region, and select the cluster you used to deploy the Collector. Navigate to the **Tasks** tab and check if the task is running.
Task status running 1. Finally, select the **task** and click on the **Networking** tab. You'll find the information on where to send telemetry data.
If you plan to send data to the ECS Collector service from a container running in the bridge network mode using the same host, you can use Docker Gateway IP - 172.17.0.1 on EC2 Linux in the application environment variables. For example: @@ -111,9 +113,9 @@ You'll need an ECS Cluster where the Sumo Logic Distribution for OpenTelemetry C ```bash aws cloudformation create-stack --stack-name sumologic-aws-otel-col-ecs-fargate --template-body file://${TEMPLATE_PATH} --parameters ParameterKey=ClusterName,ParameterValue=${CLUSTER_NAME} ParameterKey=SecurityGroups,ParameterValue=\"${SECURITY_GROUPS}\" ParameterKey=Subnets,ParameterValue=\"${SUBNETS}\" --capabilities=CAPABILITY_NAMED_IAM --region=${AWS_REGION} ``` -1. To check if everything was deployed, go to the [CloudFormation Stacks console](https://console.aws.amazon.com/cloudformation/home#/stacks?filteringStatus=active&filteringText=&viewNested=true&hideStacks=false) and check if the **sumologic-aws-otel-col-ecs-fargate** stack status is **CREATE_COMPLETE**.
![ecs ec2 stack status.png](/img/apm/traces/ecs-ec2-stack-status.png) -1. The next step is to check if your deployment is properly running. Go to the [ECS Console](https://console.aws.amazon.com/ecs/home), select the proper region, and select the cluster you used to deploy the AWS OpenTelemetry Collector. Navigate to the **Tasks** tab and check if the task is running.
![task status es2 ecs.png](/img/apm/traces/task-status-es2-ecs.png) -1. Finally, click on the task and expand the **Containers** list. In the **Network > Private IP** or **Public IP** sections, you will find the information on where to send telemetry data.
![network ips.png](/img/apm/traces/network-ips.png) +1. To check if everything was deployed, go to the [CloudFormation Stacks console](https://console.aws.amazon.com/cloudformation/home#/stacks?filteringStatus=active&filteringText=&viewNested=true&hideStacks=false) and check if the **sumologic-aws-otel-col-ecs-fargate** stack status is **CREATE_COMPLETE**.
ECS EC2 stack status +1. The next step is to check if your deployment is properly running. Go to the [ECS Console](https://console.aws.amazon.com/ecs/home), select the proper region, and select the cluster you used to deploy the AWS OpenTelemetry Collector. Navigate to the **Tasks** tab and check if the task is running.
Task status EC2 ECS +1. Finally, click on the task and expand the **Containers** list. In the **Network > Private IP** or **Public IP** sections, you will find the information on where to send telemetry data.
Network IPs ## Amazon Elastic Computing (EC2) @@ -131,8 +133,8 @@ You'll need an ECS Cluster where the Sumo Logic Distribution for OpenTelemetry C ```bash aws cloudformation create-stack --stack-name sumologic-otel-ec2 --template-body file://${TEMPLATE_PATH} --parameters ParameterKey=SumoOtlpHttpEndpointURL,ParameterValue=${SUMO_OTLP_HTTP_ENDPOINT_URL} ParameterKey=SSHKeyName,ParameterValue=${SSH_KEY_NAME} ParameterKey=InstanceAMI,ParameterValue=${AMI_ID} --capabilities=CAPABILITY_NAMED_IAM --region=${AWS_REGION} ``` -1. To check if everything was deployed, go to [CloudFormation Stacks console](https://console.aws.amazon.com/cloudformation/home#/stacks?filteringStatus=active&filteringText=&viewNested=true&hideStacks=false) and check if **sumologic-otel-ec2** stack status is **CREATE_COMPLETE**. Deploying and configuring an EC2 instance can take even a few minutes.
![stack check.png](/img/apm/traces/stack-check.png) -1. Go to [EC2 Instances](https://console.aws.amazon.com/ec2/v2/home#Instances:instanceState=running), select the proper region and check if the EC2 instance is running. Use public or private IP addresses as exporters endpoints.
![instance ips.png](/img/apm/traces/instance-ips.png) +1. To check if everything was deployed, go to [CloudFormation Stacks console](https://console.aws.amazon.com/cloudformation/home#/stacks?filteringStatus=active&filteringText=&viewNested=true&hideStacks=false) and check if **sumologic-otel-ec2** stack status is **CREATE_COMPLETE**. Deploying and configuring an EC2 instance can take even a few minutes.
Stack check +1. Go to [EC2 Instances](https://console.aws.amazon.com/ec2/v2/home#Instances:instanceState=running), select the proper region and check if the EC2 instance is running. Use public or private IP addresses as exporters endpoints.
Instance IPs ## Sumo Logic Distribution for OpenTelemetry installation on EKS diff --git a/docs/apm/traces/get-started-transaction-tracing/set-up-traces-collection-for-other-environments.md b/docs/apm/traces/get-started-transaction-tracing/set-up-traces-collection-for-other-environments.md index 7ada7d8494..47d986f808 100644 --- a/docs/apm/traces/get-started-transaction-tracing/set-up-traces-collection-for-other-environments.md +++ b/docs/apm/traces/get-started-transaction-tracing/set-up-traces-collection-for-other-environments.md @@ -5,6 +5,8 @@ sidebar_label: Other Environment Setup description: Sumo Logic leverages OpenTelemetry standards for trace collection. --- +import useBaseUrl from '@docusaurus/useBaseUrl'; + Sumo Logic leverages OpenTelemetry standards for trace collection. To gather the spans generated by tracing clients, follow the instructions at [Instrument your application with OpenTelemetry](/docs/apm/traces/get-started-transaction-tracing/opentelemetry-instrumentation). Additionally, you'll need to run the OpenTelemetry Collector instance. It receives and buffers data, optionally attaches metadata tags, and pushes them to a Sumo Logic Hosted Collector endpoint that resides in the cloud. @@ -18,7 +20,7 @@ Depending on the architecture of the environment, OpenTelemetry Collector can be Due to the fact that vital metadata (information about the host and its OS) is available only for collectors inside individual node/host, we recommend that instances of OpenTelemetry Collector should be run at least on each of the nodes/hosts as **agents**. Doing so allows you to collect metadata tags locally and also in case of high volume environments, to buffer the messages, reducing the number of requests for each individual collector instance. -![OpenTelemetry Deployment](/img/apm/traces/OpenTelemetry-Deployment.png) +OpenTelemetry deployment ## Prerequisites diff --git a/docs/apm/traces/search-query-language-support-for-traces.md b/docs/apm/traces/search-query-language-support-for-traces.md index 49fc89900c..274b670825 100644 --- a/docs/apm/traces/search-query-language-support-for-traces.md +++ b/docs/apm/traces/search-query-language-support-for-traces.md @@ -5,6 +5,8 @@ sidebar_label: Search Query Language support description: Use our extensive Search Query Language to gain valuable insight into your traces. --- +import useBaseUrl from '@docusaurus/useBaseUrl'; + You can use our [Search Query Language](/docs/search/search-query-language) in a log search to query raw spans from tracing data for the same period as the default partition. Tracing data retention in `_trace_spans` index is the same as default log index retention. @@ -51,7 +53,7 @@ You can parse your spans in the same way you parse log data. This includes any v ### View Your Search Results -When viewing your search results you can add any parsed fields to display by selecting them from the Field Browser on the left, or by using the fields operator in your query. The following image shows a query using the `fields` operator to display `operation`, `service`, `spanid`, `statuscode`, and `traceid`. The Field Browser can also set the fields to display.
![spans search with fields highlighted.png](/img/apm/spans-search-with-fields-highlighted.png) +When viewing your search results you can add any parsed fields to display by selecting them from the Field Browser on the left, or by using the fields operator in your query. The following image shows a query using the `fields` operator to display `operation`, `service`, `spanid`, `statuscode`, and `traceid`. The Field Browser can also set the fields to display.
Spans search with fields highlighted ### Monitors and Scheduled Searches You can also set Monitors and Scheduled Searches for Traces. @@ -105,14 +107,14 @@ _index=_trace_spans | fields operation, service, spanid, statuscode, traceid ``` -![spans basic example with where operations.png](/img/apm/spans-basic-example-with-where-operations.png) +spans basic example with where operations #### Break them down by HTTP code status To find out more details about the errors found in the example above you can look in the **tags** field and view the `http.status_code` field. -![img](/img/apm/traces/http-code-status.png) +HTTP code status To extract this tag as a new field and filter it to show only codes below 500 (4xx essentially) you could run the following query: @@ -124,7 +126,7 @@ _index=_trace_spans | where code < 500 ``` -![spans with where operation example.png](/img/apm/spans-with-where-operation-example.png) +Spans with where operation exampl ### View errors by status over time @@ -145,4 +147,4 @@ _index=_trace_spans The column chart displayed in the following screenshot has normal stacking selected. -![new index spans over time example.png](/img/apm/traces/new-index-spans-over-time-example.png) +New index spans over time example diff --git a/docs/apm/traces/tracing-dashboards.md b/docs/apm/traces/tracing-dashboards.md index 986868b258..b3a8b415ea 100644 --- a/docs/apm/traces/tracing-dashboards.md +++ b/docs/apm/traces/tracing-dashboards.md @@ -15,11 +15,11 @@ Out-of-the-box dashboards are available as three hierarchies. * The **APM: Application View** groups services into higher-level applications based on the `application=[app-name]` custom tag that you may add to your tracing data if you want to leverage it fully. Without the tag, all services will belong to a "default" application. The fourth and last level of the hierarchy shows the top 50 most active operations executed on the service. See [Working with Span attributes](/docs/apm/traces/advanced-configuration/working-with-span-attributes) to learn how to customize your span attributes and set up application name. * The **APM: Service View** takes a contrary approach, displaying services by top level and breaking down their health by application. This view can be useful for shared services that support more than one application. The fourth level shows the top 50 most active operations performed on the selected service and application. -* The **APM: Environment View** displays environments at the top level and breaks down application health by environment (such as `prod` or `dev`), with up to 10 values of **deployment.environment** tag. This view can be useful for understanding the top-down hierarchy of applications and services in a particular environment. The fourth level shows the top 50 most active operations executed on the environment, application, and service.
Service Dashboards from traces
Services must be active within the last 15 minutes to appear on the list. Recent inactivity will result in a grayed-out list entry. +* The **APM: Environment View** displays environments at the top level and breaks down application health by environment (such as `prod` or `dev`), with up to 10 values of **deployment.environment** tag. This view can be useful for understanding the top-down hierarchy of applications and services in a particular environment. The fourth level shows the top 50 most active operations executed on the environment, application, and service.
Service Dashboards from traces
Services must be active within the last 15 minutes to appear on the list. Recent inactivity will result in a grayed-out list entry. Each dashboard is a fully customizable set of panels based on automatically generated metrics using tracing data as input. You can get insight into microservice health by looking at stats from: -* **Latency**: (real-time average) the average time it takes for entry spans for that service to complete. Apart from average you can also select p99, p95, p90, p50 options in the `latency_type` filter to view other percentile aggregations. Percentile aggregations are based on the [metrics histograms](/docs/metrics/introduction/metric-histograms/) feature.
![latency-type.png](/img/apm/traces/latency-type.png) +* **Latency**: (real-time average) the average time it takes for entry spans for that service to complete. Apart from average you can also select p99, p95, p90, p50 options in the `latency_type` filter to view other percentile aggregations. Percentile aggregations are based on the [metrics histograms](/docs/metrics/introduction/metric-histograms/) feature.
Latency type * **Requests**: (real-time counter) the number of entry spans reported by the service. * **Errors**: (real-time counter) the number of entry spans for the service that finished with an error. @@ -77,10 +77,10 @@ You are limited to three Trace List panels in a dashboard. To add a Trace List panel to your Dashboard: 1. Open or create a new Dashboard. -2. Click **Add Panel** and select **Trace List**. Or select the **Trace List** option on a new Dashboard.
![add-tracelist.png](/img/apm/traces/add-tracelist.png) - A panel configuration page opens.
![create-tracelist.png](/img/apm/traces/create-tracelist.png) -3. Configure a [Trace query](view-and-investigate-traces.md) to search for desired set of traces.  -4. Select a time range or create a custom range for the panel. You can set this when creating or at any time when viewing the Dashboard panel.
![timerange.png](/img/apm/traces/timerange.png) +2. Click **Add Panel** and select **Trace List**. Or select the **Trace List** option on a new Dashboard.
Add tracelist +
A panel configuration page opens.
Create-tracelist +3. Configure a [Trace query](view-and-investigate-traces.md) to search for desired set of traces. +4. Select a time range or create a custom range for the panel. You can set this when creating or at any time when viewing the Dashboard panel.
Time range 5. The **Chart Type** is set to Table. 6. Enter the **Rows Per Page** for the panel, between 5 to 100. The default amount is 15. The panel automatically paginates traces to browse through and view all traces. 7. Select the Table columns of trace data to load in the panel: @@ -92,59 +92,59 @@ To add a Trace List panel to your Dashboard: | Started At | 07/27/2020 09:01:04.533 | When the trace started. | | Duration | 12.582 ms | The amount of time the trace spans. | | Number of spans | 35 | A trace consists of spans. This number tells you how many spans are in the trace. | - | Duration Breakdown | ![breakdown](/img/apm/traces/breakdown.png) | Each color indicates a service. The colors assigned to services are always the same on your account. You can change the color in the span summary tab after clicking on the individual span in trace view.
Hover over to view a percentage breakdown of how long each span covers in the trace.
![img](/img/apm/span-hover-view.png) | + | Duration Breakdown | 300 | Each color indicates a service. The colors assigned to services are always the same on your account. You can change the color in the span summary tab after clicking on the individual span in trace view.
Hover over to view a percentage breakdown of how long each span covers in the trace.
Duration breakdown legend | | Number of errors | 0 | The number of errors in the trace. | - | Status | 200 | The HTTP status code of the trace. A menu is available in this column when hovering on a row. The menu has an option to **Show similar traces**.
![img](/img/apm/traces/similar-traces-menu.png) | + | Status | 200 | The HTTP status code of the trace. A menu is available in this column when hovering on a row. The menu has an option to **Show similar traces**.
Traces status | -8. Click the **General** tab to edit the Panel Details. Enter a name for the panel, set a **Title Font Size**, and add a short **Description**.
trace-list> -9. Click **Add to Dashboard**. The panel loads in your Dashboard to review all traces according to the query.
![panel-trace.png](/img/apm/traces/panel-trace.png) +8. Click the **General** tab to edit the Panel Details. Enter a name for the panel, set a **Title Font Size**, and add a short **Description**.
Trace list +9. Click **Add to Dashboard**. The panel loads in your Dashboard to review all traces according to the query.
Panel trace ### Dashboard Examples #### 01. Application Service Overview -APM Dashboard +APM Dashboard #### 01. Environment Overview -APM Dashboard +APM Dashboard #### 01. Operation Overview -APM Dashboard +APM Dashboard #### 02. Service Health Across Applications -APM Dashboard +APM Dashboard #### 02. Service Health Across Applications within Environment -APM Dashboard +APM Dashboard #### 03. Application Service Health Across Operations -APM Dashboard +APM Dashboard #### 03. Application Service Health Across Operations within Environment -APM Dashboard +APM Dashboard #### 04. Application Health Across Services -APM Dashboard +APM Dashboard #### 04. Service Health Across Applications and Operations -APM Dashboard +APM Dashboard #### 04. Service Health Across Applications and Operations within Environment -APM Dashboard +APM Dashboard #### 05. Application Service Health Across Environments -APM Dashboard +APM Dashboard #### 06. Service Health Across Environments -APM Dashboard +APM Dashboard diff --git a/docs/apm/traces/view-and-investigate-traces.md b/docs/apm/traces/view-and-investigate-traces.md index 4b9cd67847..bd4fac310d 100644 --- a/docs/apm/traces/view-and-investigate-traces.md +++ b/docs/apm/traces/view-and-investigate-traces.md @@ -16,7 +16,7 @@ You can visualize your Traces data through filtered trace lists and icicle chart Here, you can run a Trace query, view your **Trace Duration Breakdown Chart**, and explore your **Traces matching queries** table. -![trace-page.png](/img/apm/traces/trace-page.png) +Trace page ### Trace queries @@ -39,15 +39,15 @@ As well as any other metadata standard or custom we may find in spans. All metad #### Write a Trace query -To write a Trace query, click on the **Choose filters** input line. You can select the desired filter type and value from the dropdown menu or manually type them. Multiple filters are allowed in a query row, `AND` is implicit.
![filters.png](/img/apm/traces/trace-filters.png) +To write a Trace query, click on the **Choose filters** input line. You can select the desired filter type and value from the dropdown menu or manually type them. Multiple filters are allowed in a query row, `AND` is implicit.
Filters -You can add more queries by clicking the **+** icon on the right of the query row.
![Add trace query.png](/img/apm/traces/Add-trace-query.png) +You can add more queries by clicking the **+** icon on the right of the query row.
Add trace query -Each query is labeled with a letter. In the following screenshot, the first query on the top row is labeled **#A** and the second query is labeled **#B**.
![trace-queries.png](/img/apm/traces/trace-queries.png) +Each query is labeled with a letter. In the following screenshot, the first query on the top row is labeled **#A** and the second query is labeled **#B**.
Trace queries #### Visibility -Use the eye icon to toggle the visibility of results from a query. When hidden, the traces returned from the query in the row are not displayed in your results.
![trace-hide-show.png](/img/apm/traces/trace-hide-show.png) +Use the eye icon to toggle the visibility of results from a query. When hidden, the traces returned from the query in the row are not displayed in your results.
Trace hide show #### Set Time Range @@ -59,7 +59,7 @@ Queries above 7 days may be slower to load. #### Refresh results -The results are not automatically updated. If you want to refresh traces, click the refresh button on the top right corner of the page.
![Refresh.png](/img/apm/traces/Refresh.png) +The results are not automatically updated. If you want to refresh traces, click the refresh button on the top right corner of the page.
Refresh ### Trace Query Visualizations @@ -142,22 +142,22 @@ In the **Traces matching queries** table, Traces are displayed in the following | Started At | `07/27/2020 09:01:04.533` | When the trace started. | | Duration | `12.582 ms` | The amount of time the trace spans. | | Number of spans | `35` | A trace consists of spans. This number tells you how many spans are in the trace. | -| Duration Breakdown | ![breakdown](/img/apm/traces/breakdown.png) | Each color indicates a service. The colors assigned to services are always the same on your account. You can change the color in the span summary tab after clicking on the individual span in trace view.
Hover over to view a percentage breakdown of how long each span covers in the trace.
![img](/img/apm/span-hover-view.png) | +| Duration Breakdown | Breakdown | Each color indicates a service. The colors assigned to services are always the same on your account. You can change the color in the span summary tab after clicking on the individual span in trace view.
Hover over to view a percentage breakdown of how long each span covers in the trace.
Duration breakdown legend | | Number of errors | `0` | The number of errors in the trace. | -| Status | `200` | The HTTP status code of the trace. A menu is available in this column when hovering on a row. The menu has an option to **Show similar traces**.
![img](/img/apm/traces/similar-traces-menu.png) | +| Status | `200` | The HTTP status code of the trace. A menu is available in this column when hovering on a row. The menu has an option to **Show similar traces**.
Show similar traces | :::note Changes to your View are preserved when switching between other tabs. ::: -Next, open Trace View by clicking on any row.
![traces-table-row.png](/img/apm/traces/traces-table-row.png) +Next, open Trace View by clicking on any row.
Traces table row ## Trace View Trace View shows the time flow of a single trace by its spans, and displays the relationships between the spans across your transaction. -![trace-view.png](/img/apm/traces/trace-view.png) +Trace view With log drilldowns and infrastructure metrics, Trace View helps you: * Investigate the lifetime of your transactions @@ -166,11 +166,11 @@ Trace View shows the time flow of a single trace by its spans, and displays the * Visualize all of your different services, each represented in a different color Navigation tips: -* Zoom in and out on spans using your mouse to drag and pan, or use the buttons in the bottom left, where you can also reset the view.
trace-zooms.png +* Zoom in and out on spans using your mouse to drag and pan, or use the buttons in the bottom left, where you can also reset the view.
Trace zooms * Use the **Filters** bar to filter by values of metadata tags in spans. -* Use the **Error Spans Only** toggle to hide or show error spans and the **Hide all services** button to hide services.
toggle-and-button-hide.png -* Hover over a span segment to view the parent span information and relationship, including the service, operation, relative start in milliseconds, and duration in milliseconds.
![trace-view-details.png](/img/apm/traces/trace-view-details2.png) ![trace-view-details.png](/img/apm/traces/trace-view-details.png) -* Hide services that are of less interest by clicking on a segment underneath the **Critical path contribution by service** label. This section displays the sequence of service span segments that contribute to the total trace execution time. Each colored segment summarizes all span fragments from a single service, where there was no child span activity.
![critical path on trace view.png](/img/apm/traces/critical-path-on-trace-view.png) +* Use the **Error Spans Only** toggle to hide or show error spans and the **Hide all services** button to hide services.
Toggle and button hide +* Hover over a span segment to view the parent span information and relationship, including the service, operation, relative start in milliseconds, and duration in milliseconds.
Trace view details
Trace view details +* Hide services that are of less interest by clicking on a segment underneath the **Critical path contribution by service** label. This section displays the sequence of service span segments that contribute to the total trace execution time. Each colored segment summarizes all span fragments from a single service, where there was no child span activity.
Critical path on trace view Click on a span segment to open the details side panel, which contains the following tabs. @@ -190,13 +190,13 @@ If no logs are produced for this spanID, results may come back empty. [Learn how You can change the color of a **Service** by clicking the colored box and selecting a defined swatch or custom color. -service color traces span.png +Service color traces span ### Metadata Lists all of the related service entities involved in the span, including a complete set of span's tags. You can click on the clipboard icon to copy the value to your computer's clipboard. -trace-details-metadata.png +Tace details metadata The Metadata includes a [Span Event](#span-events) section. @@ -204,10 +204,9 @@ The Metadata includes a [Span Event](#span-events) section. Span Events describe and contextualize the work being done under a span by tracing and displaying that data in Trace Views. Events are optional time-stamped strings, which are made up of timestamp, name, and (optional) key-value pair attributes. -![span-event-select.png](/img/apm/span-event-select.png) +Span event select -You can also get to the **Metadata** tab > **Span Events** section by selecting a span event marker ![span-event-marker.png](/img/apm/span-event-marker.png) in the timeline or a span with an event.
-![span-event-markers.gif](/img/apm/span-event-markers.gif) +You can also get to the **Metadata** tab > **Span Events** section by selecting a span event marker Span event marker in the timeline or a span with an event.
Span event markers Span Event data includes: @@ -223,9 +222,9 @@ Each event tracks a marker in the span timeline showing the start, end, and amou If additional information is available that may be too large for the tab view area, such as a metric attributes and error message, the **Details** link displays. Click to review this information. -![span-event-more1.png](/img/apm/span-event-more1.png) +Span event more information -![span-event-more2.png](/img/apm/span-event-more2.png) +Span event additional information You can also manually create Span Events, such as this [example from Ruby](https://opentelemetry.io/docs/instrumentation/ruby/events/).  @@ -235,22 +234,22 @@ You can also manually create Span Events, such as this [example from Ruby](http Tracing focuses on the parent-child relationship between spans, which are described by a span ID, a parent span ID, and a Trace ID. You can establish more casual relationships between Traces using Span Links. -**Span Links**, listed under the Metadata tab, give spans context. Links can point to spans inside a trace or across different traces. For example, with links you can represent batch operations, where a span is initiated by multiple initiating spans, each representing one item being processed in the batch. The links give you the relationship between the originating and the following trace. You can copy the span ID by selecting the Clipboard icon next to the span link.
![links.png](/img/apm/traces/links.png) +**Span Links**, listed under the Metadata tab, give spans context. Links can point to spans inside a trace or across different traces. For example, with links you can represent batch operations, where a span is initiated by multiple initiating spans, each representing one item being processed in the batch. The links give you the relationship between the originating and the following trace. You can copy the span ID by selecting the Clipboard icon next to the span link.
Linkds Span Links are added by tracing instrumentation at the client side and are automatically shown when detected in data. For details on configuring Span Links, see the [OpenTelemetry specification](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/overview.md#links-between-spans). -You can select the Traces icon to view all other traces that link to this span ID, and it will take you to the Trace View with the `linkedSpanId` as a filter criteria.
![links.png](/img/apm/traces/links2.png) +You can select the Traces icon to view all other traces that link to this span ID, and it will take you to the Trace View with the `linkedSpanId` as a filter criteria.
Links ### Entities The **Entities** tab provides an overview of a span's supporting infrastructure health with the ability to contextually drill down to logs and metrics. Only entity types from a curated list are identified. The AWS, Kubernetes, Traces, and Host domains are supported. -entities-tab.png +Entities tab #### Time selector -Use the time selector to set if data is related to the **Now** moment of time or the moment of time around the data point you clicked on.
entities-time-selector.png +Use the time selector to set if data is related to the **Now** moment of time or the moment of time around the data point you clicked on.
Entities time selector If the **Datapoint** is the same as **Now**, the selector will not allow you to select **Now**. @@ -260,12 +259,12 @@ If the **Datapoint** is the same as **Now**, the selector will not allow yo Alerts are only visible when the [Time Selector](../../dashboards/drill-down-to-discover-root-causes.md#time-selector) is set to **Now.** ::: -Monitors track your Metrics or Logs data in real time and send notifications when noteworthy changes happen in your production applications. The **Entities** tab shows any Monitors with a Critical, Warning, or Missing Data status that are tracking logs or metrics on the Entity.
![monitor types.png](/img/dashboards/drill-root-causes/monitor-types.png) +Monitors track your Metrics or Logs data in real time and send notifications when noteworthy changes happen in your production applications. The **Entities** tab shows any Monitors with a Critical, Warning, or Missing Data status that are tracking logs or metrics on the Entity.
Monitor status Next to the Entity, you will see any of the following icons indicating the type of Monitor alert that has triggered. Click the **Triggered monitors** row to view the related Monitors. You can click on them to view the Monitor on the [Monitors](/docs/alerts/monitors) page. -triggered-monitors.png +triggered-monitors.png #### Troubleshoot links -This tab also displays troubleshooting links for related Entities and Environments. To investigate, click the **Open In** button, then select an icon to launch another feature against the entity or environment. An icon is not available if it is not a valid launch.
infrastructure tab with RCE link.png +This tab also displays troubleshooting links for related Entities and Environments. To investigate, click the **Open In** button, then select an icon to launch another feature against the entity or environment. An icon is not available if it is not a valid launch.
infrastructure tab with RCE link.png diff --git a/docs/platform-services/automation-service/automation-service-bridge.md b/docs/platform-services/automation-service/automation-service-bridge.md index 30e0f3a14f..67a65f5ffd 100644 --- a/docs/platform-services/automation-service/automation-service-bridge.md +++ b/docs/platform-services/automation-service/automation-service-bridge.md @@ -284,7 +284,7 @@ In the DooD approach, you use the Docker daemon from the host system to interact This way, the main container will have access to the Docker socket and will, therefore, be able to start containers. The only difference is that instead of starting “child” containers, it will start “sibling” containers. -![Mounting Docker socket](https://cdn.hashnode.com/res/hashnode/image/upload/v1693178230450/3b5e8d84-a6e6-40b9-acce-8b2f623e67be.png?auto=compress,format&format=webp) +Mounting Docker socket It's useful to sharing pulled image with all bridges running on host machine. diff --git a/docs/reuse/apps/create-aws-s3-source.md b/docs/reuse/apps/create-aws-s3-source.md index b3244b421d..31f3e8d944 100644 --- a/docs/reuse/apps/create-aws-s3-source.md +++ b/docs/reuse/apps/create-aws-s3-source.md @@ -17,7 +17,7 @@ The Sumo Logic S3 integration combines scan-based discovery and event-based disc When you enable event-based notifications, S3 will automatically publish new files to Amazon Simple Notification Service (SNS) topics, which Sumo Logic can be subscribed. This notifies Sumo Logic immediately when new files are added to your S3 bucket so we can collect it. For more information about SNS, see the [Amazon SNS product docs](https://aws.amazon.com/sns/). -![Cloud_AWS_icon.png](/img/integrations/amazon-aws/Cloud_AWS_icon.png) +Cloud AWS icon Enabling event-based notifications is an S3 bucket-level operation that subscribes to an SNS topic. An SNS topic is an access point that Sumo Logic can dynamically subscribe to in order to receive event notifications. When creating a Source that collects from an S3 bucket, Sumo Logic assigns an endpoint URL to the Source. The URL is for you to use in the AWS subscription to the SNS topic so AWS notifies Sumo when there are new files. See [Configuring Amazon S3 Event Notifications](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) for more information. diff --git a/docs/reuse/aws-cost-explorer.md b/docs/reuse/aws-cost-explorer.md index ca230212e5..e061690ce1 100644 --- a/docs/reuse/aws-cost-explorer.md +++ b/docs/reuse/aws-cost-explorer.md @@ -9,7 +9,7 @@ To configure an AWS Cost Explorer Source: 1. (Optional) For **Source Category**, enter any string to tag the output collected from the Source. Category [metadata](/docs/search/get-started-with-search/search-basics/built-in-metadata) is stored in a searchable field called `_sourceCategory`. 1. For [Fields](/docs/manage/fields), click the **+Add** link to add custom log metadata. Define the fields you want to associate. Each field needs a name (key) and value. * green check circle.png A green circle with a check mark is shown when the field exists and is enabled in the Fields table schema. - * orange exclamation point.png An orange triangle with an exclamation point is shown when the field doesn't exist, or is disabled in the Fields table schema. In this case, you'll see an option to automatically add or enable the nonexistent fields to the Fields table schema. If a field is sent to Sumo Logic but isn’t present or enabled in the schema, it’s ignored and marked as **Dropped**.

It is preferable to add an **account** field (for the dashboards) and assign it a friendly name to identify the corresponding AWS account.
![accountField.png](/img/send-data/accountField.png) + * orange exclamation point.png An orange triangle with an exclamation point is shown when the field doesn't exist, or is disabled in the Fields table schema. In this case, you'll see an option to automatically add or enable the nonexistent fields to the Fields table schema. If a field is sent to Sumo Logic but isn’t present or enabled in the schema, it’s ignored and marked as **Dropped**.

It is preferable to add an **account** field (for the dashboards) and assign it a friendly name to identify the corresponding AWS account.
Account field 1. For the **AWS Access Key** and **AWS Secret Key**, provide the IAM User access key and secret key you want to use to authenticate collection requests. Make sure your IAM user has the following IAM policy attached with it. ```json { diff --git a/docs/reuse/contributing/submit.md b/docs/reuse/contributing/submit.md index e94aaabaf9..9a7122db14 100644 --- a/docs/reuse/contributing/submit.md +++ b/docs/reuse/contributing/submit.md @@ -1,4 +1,6 @@ -1. Commit your changes to the branch with a meaningful message.
![pull request](/img/contributing/commit.png) Use descriptive commit messages (and issue or ticket numbers, if applicable) detailing the content updates you are entering for content. One-line messages are fine for small changes, but bigger changes should look like this: +import useBaseUrl from '@docusaurus/useBaseUrl'; + +1. Commit your changes to the branch with a meaningful message.
Pull request
Use descriptive commit messages (and issue or ticket numbers, if applicable) detailing the content updates you are entering for content. One-line messages are fine for small changes, but bigger changes should look like this: ```bash $ git commit -m "A brief summary of the commit > @@ -6,7 +8,7 @@ ``` 1. Set permissions to allow maintainers to edit and update the PR ([learn more](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork)). 1. Push your branch to the forked repo. -1. Visit [our repo](https://github.com/SumoLogic/sumologic-documentation) after pushing your branch. If you see an option to **Compare & pull request** for your branch, click this.
![compare](/img/contributing/compare-pr.png) +1. Visit [our repo](https://github.com/SumoLogic/sumologic-documentation) after pushing your branch. If you see an option to **Compare & pull request** for your branch, click this.
Compare * If you do not see it, [create a new PR](https://github.com/SumoLogic/sumologic-documentation/compare). 1. Select `main` for the base branch. This is the branch all staging and production content builds from. 1. Select your branch for the **compare**. @@ -21,5 +23,5 @@ 1. Add the GA release date to the title. For example, `AWS Integration release (GA: Jan 1, 2023)`. 1. From the labels list, select the `hot🔥` label, signifying it's an extremely urgent PR. 1. For internal Sumos only: after completion of all GitHub checks, send your PR link to the `#doc-int` and `#open-source` Slack channels for review. -1. Click **Create pull request**.
![pull request](/img/contributing/pull-request.png) -1. First-time contributors will be prompted in a comment to sign our Contributor License Agreement. We allow individual contributions and contributions made on behalf of companies.
![CLA bot](/img/contributing/clabot.png) +1. Click **Create pull request**.
Pull request +1. First-time contributors will be prompted in a comment to sign our Contributor License Agreement. We allow individual contributions and contributions made on behalf of companies.
CLA bot