Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding more about compare - Services #301

Closed
wants to merge 1 commit into from
Closed

Adding more about compare - Services #301

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 30 additions & 12 deletions docs/user-guide/distributed-tracing/service-list.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ sidebar_position: 4

# Service List

The **Service list** dashboard centralizes all of your running services, allowing you to detect if and when issues occur quickly. You can use the dashboard to investigate the different services, operations, and logs inside each one.
The **Service list** dashboard centralizes all of your running services, allowing you to quickly detect if and when issues occur. You can use the dashboard to investigate the different services, operations, and logs inside each one.

![Services](https://dytvr9ot2sszz.cloudfront.net/logz-docs/services/service-list-overview.png)
![Services](https://dytvr9ot2sszz.cloudfront.net/logz-docs/services/services-main-dev.png)

## Service list overview

Expand All @@ -19,15 +19,33 @@ The main Service list table view contains the following details:
* **Latency** - The duration it takes data to travel in the environment, presented in milliseconds and graph view
* **Error ratio** - Both percentage and graph view

You can change your view by comparing the data to a previous time frame, such as the last day or week. You can also choose a different time frame that ranges from 2 hours ago and up to 24 hours ago.
At the top of the chart, you can adjust the view to match your monitoring needs.

If you’re looking for a specific service, start typing its name in the search box, and your view will change to display all the matching results.
You can **compare** your view to a previous time frame and view the differences in the graphs and trends.

![service compare](https://dytvr9ot2sszz.cloudfront.net/logz-docs/services/compare-services1.png)

**Change the time frame** to range from 2 hours ago and up to 2 days ago.

![service time](https://dytvr9ot2sszz.cloudfront.net/logz-docs/services/services-last1.png)

Choose which **environments and operations** you want to display in the chart.

![service filters](https://dytvr9ot2sszz.cloudfront.net/logz-docs/services/services-filters1.png)

Or, if you're looking for a specific service, use the **search** to see all the matching results.

![service search](https://dytvr9ot2sszz.cloudfront.net/logz-docs/services/services-search.png)

Clicking on the **Clear filters** will remove all of the filters.

## Dive deeper into your services

Clicking on one of the services opens a new page with additional info, including a visual representation of the service’s current error ratio, request rate, latency, and a breakdown of the service’s operations, infrastructure, and logs.
Clicking on one of the services opens a new page with additional info, including a visual representation of the service’s current error ratio, request rate, latency, and a breakdown of the service’s operations, infrastructure, and logs. Each data point is compared to the time frame of your choice (last day or last week), helping you understand the trends and know which area you should focus on.

At the top of the page, you can change the time frame, choose which nodes or pods to focus on, or manually update the data by clicking on the refresh icon.

![service deeper](https://dytvr9ot2sszz.cloudfront.net/logz-docs/services/service-overview.png)
![service deeper](https://dytvr9ot2sszz.cloudfront.net/logz-docs/services/services-inner-dec.png)

Hovering over the graphs provides additional info for the time point you've chosen:

Expand All @@ -39,10 +57,10 @@ Hovering over the graphs provides additional info for the time point you've chos

### Operations overview

This table includes all of the operations running inside the chosen service, with this additional data:
This table includes all of the operations running inside the chosen service with this additional data:

* **Operation** name
* Operation’s **Impact** level, calculated based on the latency and request rate
* The operation’s **Impact** level, calculated based on the latency and request rate
* **Request rate** - Number of requests per second, in numeral and graph view
* **Latency** - The duration it takes data to travel in the environment, presented in milliseconds and graph view
* **Error ratio** - Both percentage and graph view
Expand All @@ -51,25 +69,25 @@ Use the search bar to find a specific operation or the arrows at the bottom of t

Click on an operation's name to view its detailed trace. The trace dashboard helps you pinpoint where failures occur and find the leading contributors to slow transaction performance.

![operations view](https://dytvr9ot2sszz.cloudfront.net/logz-docs/services/operations-view.png)
![operations view](https://dytvr9ot2sszz.cloudfront.net/logz-docs/services/operations-overview-dec.png)

### Infrastructure overview

View the CPU and memory consumption inside the service. The graphs represent a breakdown of consumption by the hour.

Hovering over the graphs provides values for the specific time point, allowing you to see how much CPU was used by the deployment at this specific time, or view how much memory this deployment used.
Hovering over the graphs provides values for the specific time point, allowing you to see how much CPU was used by the deployment at this specific time or how much memory this deployment used.

![hovering graph](https://dytvr9ot2sszz.cloudfront.net/logz-docs/services/hover-infra.png)

You can toggle your view between pods and nodes inside the service.

## Track Deployment Data

You can enrich your Service Overview graphs by adding an indication of recent deployments, helping you determine if a deployment has increased response times for end-users, altered your application's memory/CPU footprint, or introduced any other performance-related changes.
You can enrich your Service Overview graphs by indicating recent deployments, helping you determine if a deployment has increased response times for end-users, altered your application's memory/CPU footprint, or introduced any other performance-related changes.

To enable deployment tracking ability, run the [**Telemetry Collector**](https://app.logz.io/#/dashboard/send-your-data/agent/new) on your Kubernetes clusters. You can also activate this process **manually** by installing [Logz.io Kubernetes events Helm chart](https://app.logz.io/#/dashboard/integrations/Kubernetes:~:text=user%20guide.-,Send%20your%20deploy%20events%20logs,-This%20integration%20sends) and sending Kubernetes deploy events logs.

Once enabled, navigate to [Services](https://app.logz.io/#/dashboard/spm/service-list/table?timeFrame=2h&compareTo=1d) and choose one of your running services. The deployment marker will appear in your graphs, marked by a dotted vertical line.
Once enabled, navigate to [Services](https://app.logz.io/#/dashboard/spm/service-list/table?timeFrame=2h&compareTo=1d) and choose one of your running services. The deployment marker will appear in your graphs, marked by a vertical line.

![deployment popup](https://dytvr9ot2sszz.cloudfront.net/logz-docs/services/deplyment-popup.png)

Expand Down