diff --git a/docs/shipping/App360/App360.md b/docs/shipping/App360/App360.md index e6795d63..c6aa6477 100644 --- a/docs/shipping/App360/App360.md +++ b/docs/shipping/App360/App360.md @@ -16,7 +16,7 @@ drop_filter: [] -[App360](https://docs.logz.io/docs/user-guide/distributed-tracing/spm/) is a high-level monitoring dashboard within Logz.io that enables you to monitor your operations. This integration allows you to configure the OpenTelemetry collector to send data from your OpenTelemetry installation to Logz.io using App360. +[App360](https://docs.logz.io/docs/user-guide/app360/service-list/) is a high-level monitoring dashboard within Logz.io that enables you to monitor your operations. This integration allows you to configure the OpenTelemetry collector to send data from your OpenTelemetry installation to Logz.io using App360. diff --git a/docs/user-guide/distributed-tracing/setup-spm.md b/docs/user-guide/distributed-tracing/setup-spm.md deleted file mode 100644 index 82ae7c32..00000000 --- a/docs/user-guide/distributed-tracing/setup-spm.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -sidebar_position: 6 -title: Setup Your Service Performance Monitoring Dashboard -description: Configure your SPM dashboard -image: https://dytvr9ot2sszz.cloudfront.net/logz-docs/social-assets/docs-social.jpg -keywords: [logz.io, traces, tracing, spm, service performance monitoring, observability, distributed tracing] ---- - - -Logz.io Service Performance Monitoring dashboard (SPM) provides an overview of your systems' health by aggregating **Request**, **Error**, and **Duration** (R.E.D) metrics from span data. The dashboard helps you to pinpoint and isolate incidents in your system quickly. - - -The following guide helps you configure the OpenTelemetry collector to extract metrics from spans generated from your application instrumentation, and send them to Logz.io. - -Once configured and deployed, the collector accepts the spans and processes them through two pipelines: - -The first pipeline sends the spans to the Logz.io backend, where you can analyze single traces and focus on slowness and bottlenecks. - -The second pipeline extracts the metrics from the same spans, aggregates them, and sends them to Logz.io’s Prometheus-based account. - -### Activate the Service Performance Monitoring dashboard - -:::note -Only account admins can activate the Service Performance Monitoring dashboard. -::: - -To get started with Service Performance Monitoring, navigate to **[Tracing](https://app.logz.io/#/dashboard/jaeger)**, switch to the Monitor tab located at the top of the screen, and click on the **Start now** button. - -![Get started screen](https://dytvr9ot2sszz.cloudfront.net/logz-docs/distributed-tracing/monitor-start-screen.png) - -You'll then be given a heads up that SPM requires an active **[Metrics](https://app.logz.io/#/dashboard/metrics)** plan. If you don't have an active Metrics plan, a trial account will be automatically created for you, **free of charge**. - -> _The Metrics account trial will be available for **2 weeks**. Afterward, you'll need to **purchase a Metrics plan** to continue using your Service Performance Monitoring dashboard._ - -If you have an active Metrics plan, the Service Performance Monitoring dashboard will try to allocate data from your existing plan. To run, you need between **1,000-5,000 UTS** in your Metric plan **that are not assigned to any account**. - -Once setup is complete, you can change and re-adjust your data allocation by navigating to the **[Manage accounts](https://app.logz.io/#/dashboard/settings/manage-accounts)** page. - -If you don't have enough UTS available in your existing Metrics account, you'll need to **[re-allocate](https://app.logz.io/#/dashboard/settings/manage-accounts)** or **[purchase additional UTS](https://app.logz.io/#/dashboard/settings/plan-and-billing/plan)** to your account. - - -### Logz.io sub account users - -You can only activate Service Performance Monitoring from your **main Logz.io account**. - -If you want to add Service Performance Monitoring to a Tracing account that's only visible from a sub account, you’ll need first to add visibility to the **main account**. - -For example, Sock Shop-Tracing DEV is only visible from the sub account Sock Shop DEV: - -![Sock shop DEV](https://dytvr9ot2sszz.cloudfront.net/logz-docs/distributed-tracing/tracing-dev-account-visibility.png) - -In this case, you only have visibility to Sock Shop-Tracing DEV from the sub account Sock Shop DEV, and **you won't be able to activate** Service Performance Monitoring for this Tracing account. - -To enable Service Performance Monitoring, you'll need to add Sock Shop (the main account) to the list of authorized accounts. - -![Add sock shop](https://dytvr9ot2sszz.cloudfront.net/logz-docs/distributed-tracing/tracing-dev-add-account.png) - -After adding the main Sock Shop account to the list inside your Sock Shop-Tracing DEV settings, you'll have access to the Sock Shop-Tracing DEV account from the main Sock Shop account, and you’ll be able to go through the activation process. - -![View all Tracing accounts](https://dytvr9ot2sszz.cloudfront.net/logz-docs/distributed-tracing/monitor-sub-account-start-now.png) - -This process is only required for the duration of the activation process. Once activation is complete, you can restore your original account settings and remove Sock Shop from the list of authorized accounts. - - - - - -### Configure and ship your data - -You'll need to configure your existing integrations to extract metrics from your data. - -Log into your Logz.io account, navigate to the [Integration hub](https://app.logz.io/#/dashboard/integrations/collectors?tags=Quick%20Setup), and choose your existing integration. Go through the configuration steps and run the newly generated collector to activate your metrics SPM dashboard. - - - -Before deploying, make sure the collector you're using is version **v0.44.0** and up. - -Once everything is set, restart the collector to apply the configuration changes. - -### Check Logz.io for your metrics - -Give your metrics some time to reach and render from your system to Logz.io, then navigate to **[Tracing](https://app.logz.io/#/dashboard/jaeger/) > [Monitor](https://app.logz.io/#/dashboard/jaeger/monitor)** to view the aggregated metrics for your services and operations. \ No newline at end of file diff --git a/docs/user-guide/distributed-tracing/spm.md b/docs/user-guide/distributed-tracing/spm.md deleted file mode 100644 index 4cf38ecc..00000000 --- a/docs/user-guide/distributed-tracing/spm.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -sidebar_position: 5 -title: Getting Started with Service Performance Monitoring -description: Get a high-level monitoring dashboard with Service Performance Monitoring -image: https://dytvr9ot2sszz.cloudfront.net/logz-docs/social-assets/docs-social.jpg -keywords: [logz.io, traces, tracing, spm, service performance monitoring, observability, distributed tracing] ---- - - - -Distributed tracing assists users by highlighting and analyzing the journey of specific requests, making it easier to track application requests across distributed platforms and microservices architecture. - -However, most users have millions of traces at hand, and trying to find a bottleneck or pinpoint a specific incident is difficult and time-consuming. - -That’s where Service Performance Monitoring comes in. It's a high-level monitoring dashboard that offers a better way to monitor your services and operations, providing a bird’s eye view into your systems’ health. - -Service Performance Monitoring helps cut down the time to identify and resolve anomalies, spikes and issues. It does that by aggregating Request, Error and Duration (R.E.D) metrics from span data, pointing and isolating incidents in your systems. - -## Service Performance Monitoring dashboard - -The Service Performance Monitoring dashboard is part of your [Tracing account](https://app.logz.io/#/dashboard/jaeger/monitoring), located under the **Monitor** tab. You can generate a dashboard view for each of your services, and adjust the time span between 1 hour to 2 days ago. - -![Service Performance Monitoring](https://dytvr9ot2sszz.cloudfront.net/logz-docs/distributed-tracing/jaeger-spm-dashboard.png) - -The dashboard includes the following data: - -* Request rate - Number of requests made per second -* Error rate - The total percentage of errors in this service -* Latency - The duration it took to complete the operations, indicating the 95th, 75th and 50th percentile latency - -In addition, the dashboard includes a breakdown of R.E.D data based on the operations running inside the chosen service. Each one has an impact score based on an average of R.E.D data points. To sort the data, click on the arrows next to the title of your preferred data point. - -![Operations metrics chart](https://dytvr9ot2sszz.cloudfront.net/logz-docs/distributed-tracing/spm-error-rate-highlight.png) - -To get a deeper view into the traces of each operation, click on the **View traces** button located at the end of every row. This will display all related traces, which you can investigate more thoroughly and get to the root cause of the issue. - -![View all traces](https://dytvr9ot2sszz.cloudfront.net/logz-docs/distributed-tracing/spm-view-traces-highlight.png) - -###### Additional Tracing resources: - -* [Configure your Service Performance Monitoring dashboard](/docs/user-guide/distributed-tracing/setup-spm/) -* [What is Distributed Tracing](/docs/user-guide/distributed-tracing/tracing-overview/what-tracing/) diff --git a/docs/user-guide/distributed-tracing/troubleshooting/tracing-troubleshooting.md b/docs/user-guide/distributed-tracing/troubleshooting/tracing-troubleshooting.md index 8d1b4375..a99a71b4 100644 --- a/docs/user-guide/distributed-tracing/troubleshooting/tracing-troubleshooting.md +++ b/docs/user-guide/distributed-tracing/troubleshooting/tracing-troubleshooting.md @@ -86,6 +86,5 @@ To confirm that the data is available and accessible, type `calls_total` and run ![Query of calls total](https://dytvr9ot2sszz.cloudfront.net/logz-docs/distributed-tracing/calls-total-tracing.png) -If there are no results, go through the **[Set up your Service Performance Monitoring dashboard](https://docs.logz.io/docs/user-guide/distributed-tracing/setup-spm/)** guide again to confirm that the collector is properly configured to send the data. If you can see the query's results, but the data is not visible in your Service Performance Monitoring dashboard, contact the [Logz.io Support team](mailto:help@logz.io) for additional help. \ No newline at end of file diff --git a/docs/user-guide/quick-start.md b/docs/user-guide/quick-start.md index 6479eafe..cc4e6cc0 100644 --- a/docs/user-guide/quick-start.md +++ b/docs/user-guide/quick-start.md @@ -115,7 +115,6 @@ To make the most of Distributed Tracing, check out these guides: * **[Getting started with Tracing](https://docs.logz.io/docs/user-guide/distributed-tracing/set-up-tracing/get-started-tracing/)** * **[Sending demo traces with HOTROD](https://docs.logz.io/docs/user-guide/distributed-tracing/set-up-tracing/hotrod/)** -* Combine Traces and Metrics with **[Service Performance Monitoring](https://docs.logz.io/docs/user-guide/distributed-tracing/spm/)** * **[Correlate logs and traces](https://docs.logz.io/docs/user-guide/distributed-tracing/correlate-traces/)** diff --git a/static/_redirects b/static/_redirects index d4908017..f865ebc3 100644 --- a/static/_redirects +++ b/static/_redirects @@ -376,6 +376,8 @@ /docs/user-guide/integrations/terraform/ /docs/integrations/terraform/ /docs/shipping/AWS/Lambda-extension-node/ /docs/shipping/Code/Node-js/#traces /docs/shipping/aws/lambda-extension-go/ /docs/shipping/code/go/#traces +/docs.logz.io/docs/user-guide/distributed-tracing/setup-spm/ /docs.logz.io/docs/user-guide/app360/service-list/ +/docs.logz.io/docs/user-guide/distributed-tracing/spm/ /docs.logz.io/docs/user-guide/app360/service-list/ # Shippers /shipping/ /docs/category/send-your-data/ /user-guide/log-shipping/ /docs/category/send-your-data/