-
Notifications
You must be signed in to change notification settings - Fork 25
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' of https://github.com/wavefrontHQ/docs into mst…
…aneva-doc-fixes
- Loading branch information
Showing
24 changed files
with
565 additions
and
18 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,73 @@ | ||
--- | ||
title: Monitor Your Applications (Controlled Release) | ||
tags: [applications, ebpf, traces] | ||
sidebar: doc_sidebar | ||
permalink: application_monitoring_overview.html | ||
summary: Learn how you can monitor your application using eBPF or tracing. | ||
--- | ||
|
||
{% include important.html content="This feature is enabled only for selected customers. To participate, contact your account representative or [technical support](wavefront_support_feedback.html#support)."%} | ||
|
||
You can auto-discover and monitor your applications that run on a Kubernetes cluster or monitor your applications and services through the traces and spans sent to our service. | ||
|
||
## Select How You Send Data | ||
|
||
You can explore the demo data and drill down to the service map, and other dashboards. Then, you must select how you want to send data to our service based on where the application runs or how you have configured your application. Follow these steps: | ||
|
||
<table style="width: 100%;"> | ||
<tbody> | ||
<tr> | ||
<td width="40%"> | ||
<ol> | ||
<li> | ||
Click <b>View Onboarding Instructions</b>. | ||
</li> | ||
<li> | ||
Select how you send data to our service. For example, select <b>Applications Running on Kubernetes</b>, if you are sending data via eBPF. | ||
</li> | ||
<li> | ||
Click <b>Save and Go To Services and Applications Page</b>. | ||
</li> | ||
</ol> | ||
</td> | ||
<td width="60%"> | ||
<img src="/images/monitor_applications_onboarding.png" alt="A screenshot of the annotated applications onboarding screen."/> | ||
</td> | ||
</tr> | ||
</tbody> | ||
</table> | ||
|
||
## Monitor Applications Running on Kubernetes | ||
|
||
Send data via eBPF from your applications running on Kubernetes. We can then auto-discover all the services in your Kubernetes cluster. | ||
|
||
Go to [Kubernetes App Auto-Instrumentation via Pixie](https://github.com/wavefrontHQ/observability-for-kubernetes/tree/main/operator/hack/autoinstrumentation#kubernetes-app-auto-instrumentation-via-pixie), and follow the instructions to send data and start monitoring your applications. | ||
|
||
You can use the different dashboards and monitor your applications. You can: | ||
|
||
* View the services on the [Services and Applications page](service_and_application_view.html). | ||
* See how a specific service communicates with the other services using the [Service Map](service_map.html). | ||
* Identify potential hotspots using the [Service Dashboard](tracing_service_dashboard.html). | ||
* Create charts using the RED metrics. | ||
|
||
Example: See how a specific service communicates with other services in the application on the service map. | ||
|
||
![Shows a screenshot of the service map.](images/application_monitoring_ebpf_service_map.png) | ||
|
||
## Monitor Applications Using OpenTelemetry | ||
|
||
Instrument your applications that use OpenTelemetry and send traces and spans to our service. | ||
* [Get an overview](https://docs.wavefront.com/opentelemetry_overview.html) of how to configure your applications that use OpenTelemetry and send data to our service. | ||
* The [Java tutorial](opentelemetry_java_app_tutorial.html) shows you how to auto-instrument your Java application using the OpenTelemetry Java agent and send data to our service. | ||
|
||
Once the data is in our service, you can monitor your applications and visualize the data. You can: | ||
|
||
* View the services on the [Services and Applications page](service_and_application_view.html). | ||
* See how a specific service communicates with the other services using the [Service Map](service_map.html). | ||
* Identify potential hotspots using the [Service Dashboard](tracing_service_dashboard.html). | ||
* Create charts using the RED metrics. | ||
* View the traces and spans on the [Traces Browser](/tracing_traces_browser.html). | ||
* Download the traces locally and view them later using [Offline Traces](tracing_view_offline_traces.html). | ||
|
||
Example: View the traces and spans on the Traces Browser, and identify the spans that take a long time to complete. | ||
![A screenshot of the traces browser that shows the traces.](images/app_monitoring_traces_browser.png) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,167 @@ | ||
--- | ||
title: Service Map (Controlled Release) | ||
keywords: data, distributed tracing | ||
tags: [tracing] | ||
sidebar: doc_sidebar | ||
permalink: service_map.html | ||
summary: Understand how a specific service communicates with the other services in the application. | ||
--- | ||
|
||
{% include important.html content="This feature is enabled only for selected customers. To participate, contact your account representative or [technical support](wavefront_support_feedback.html#support)."%} | ||
|
||
When you troubleshoot an application, you might need an overview of how a service communicates with the other services. The Service map helps you visualize this information. | ||
|
||
{% include note.html content="If you are using eBPF, you don't send traces to our service. Therefore, you don't see the option to drill down to the Traces Browser." %} | ||
|
||
## Service Map Features | ||
|
||
The service map lets you focus on a specific service, view Request, Error, and Duration (RED) metrics for each service, and the tracing traffic for that service. You can also drill down to the Service Dashboard and Traces Browser. | ||
|
||
To open the service map: | ||
1. Log in to your service instance. | ||
1. From the toolbar, select **Applications** > **Service and Applications**. | ||
1. Table view: Click **Service Map** for a specific service. | ||
1. Grid view: Click **Actions** > **View Service Map** for a specific service. | ||
|
||
Let's walk through the following scenario and get a quick overview of the service map. | ||
|
||
### Add More Services | ||
|
||
<table style="width: 100%;"> | ||
<tbody> | ||
<tr> | ||
<td width="55%"> | ||
Next to <b>Operation</b>, click the drop-down menu, select the service you want to see on the map, and click <b>Search</b>.<br/> | ||
|
||
You can refine your search by applying one or more filters, such as the cluster, shard, or span.kind. | ||
|
||
<br/><br/>You see the data that match your search filters and the nearest neighboring service. For example, if you filter for the beachshirts application's styling service, you only see the services that directly communicate with the styling service. | ||
|
||
</td> | ||
<td width="45%"><img src="/images/service_map_add_services.png" alt="Search for the beachshirts application using tags"/> | ||
<a name="appmap"></a> | ||
</td> | ||
</tr> | ||
</tbody> | ||
</table> | ||
|
||
### Update the Legend | ||
|
||
<table style="width: 100%;"> | ||
<tbody> | ||
<tr> | ||
<td> | ||
Click the settings icon and select Apdex, Error, or Duration. These settings can be configured by each user. | ||
<ul> | ||
<li> | ||
Error Percentage: Update the legend to highlight the data based on the error percentage. Select <b>Error %</b> from the drop-down and customize the values. The values need to be in ascending order. | ||
</li> | ||
<li> | ||
Duration: Update the legend to highlight the data based on the duration. Select <b>Duration</b> from the drop-down menu and customize the values. The values need to be in ascending order and in milliseconds. | ||
</li> | ||
<li> | ||
Apdex: Update the legend to highlight the data based on the Apdex score. Select <b>Apdex</b> from the drop-down menu. Only Super Admin users and users with the <a href="permissions_overview.html"><strong>Applications</strong> permission</a> can configure the threshold (T). | ||
</li> | ||
</ul> | ||
</td> | ||
<td markdown="span"> | ||
![Shows the settings to update the legend for the error %. You need to select error % from the drop down and then add the values in ascending order.](images/tracing_legend_settings_app_map.png) | ||
</td> | ||
</tr> | ||
</tbody> | ||
</table> | ||
|
||
### Customize the Service Map View | ||
|
||
<table style="width: 100%;"> | ||
<tbody> | ||
<tr> | ||
<td> | ||
Click the settings icon to customize how you see the services on the service map. | ||
<ul> | ||
<li> | ||
<b>Service layout</b>: Select to view the services in the default, concentric, circle, or grid layout. Choose the layout that helps you understand how your services are linked. | ||
</li> | ||
<li> | ||
<b>Show Isolated Services</b>: Enable this option to see the services that don't interact with any other services or applications. | ||
</li> | ||
<li> | ||
<b>Show External Service</b>: Enable this option to see the external applications or services, such as AWS services or Database services, your application communicates with. You can group these services too. | ||
</li> | ||
<ul> | ||
<li> | ||
<b>Group External Services</b>: Select this option if you want to group services. For example, group all the database services and view it as a single external service. | ||
</li> | ||
</ul> | ||
<li><b>Show Service Labels</b>: When you have many services in an application, the service names on the service map look cluttered. To get a clear view of your application and services, disable the <b>Show Service Labels</b> option or select <b>Fade Labels on Zoom</b>. </li> | ||
<ul> | ||
<li> | ||
<b>Fade Labels on Zoom</b>: Hides the labels of small services and gradually exposes them as you zoom in on the service map. You always see the labels of the services in red, based on the legend settings you select. | ||
</li> | ||
<li> | ||
<b>Show Node Counts</b>: Shows the number of instances of a service running in an application. For example, <b>shopping (5)</b> shows you that there are five instances of the shopping service in the beachshirts application. | ||
</li> | ||
</ul> | ||
<li> | ||
<b>Alert Settings</b>: Select the severity of the alert you want to see on the service map. For example, if you select <b>Severe</b>, you see the alerts that have the severity status set to severe marked with a red dot on the service map. | ||
</li> | ||
</ul> | ||
</td> | ||
<td> | ||
<img src="images/tracing_application_map_settings.png" alt="screenshot of the service map settings. The settings are explained on the left side."/> | ||
</td> | ||
</tr> | ||
</tbody> | ||
</table> | ||
|
||
|
||
### See Service Specific Information | ||
|
||
<table style="width: 100%;"> | ||
<tbody> | ||
<tr> | ||
<td> | ||
Click on the styling service. Now, you can: | ||
<ul> | ||
<li>View Request, Error, and Duration (RED) metrics of the specific service.</li> | ||
<li>See how the service is performing using the Apdex score.</li> | ||
<li> View how a specific service communicates with the other services in an application by clicking the <b>Focus</b> icon.</li> | ||
<li> Navigate to the Traces Browser by clicking <b>View Traces</b>. You don't see this option if you are using eBPF.</li> | ||
<li>Click <b>Actions</b> to:</li> | ||
<ul> | ||
<li> Navigate to the Traces Browser by clicking <b>View Traces</b>. You don't see this option if you are using eBPF.</li> | ||
<li> Navigate to the Operation Dashboard by clicking <b>View Operation Dashboard</b>.</li> | ||
<li> Navigate to the Service Dashboard by clicking <b>View Service Dashboard</b>.</li> | ||
<li> Navigate to the Logs Browser by clicking <b>View Logs</b>.</li> | ||
<li>Click <b>Create Alerts</b> to create smart alerts that filter noise and capture true anomalies. See <a href="service_and_application_view.html#create-alerts">Create an alert</a>.</li> | ||
<li>If an alert you created is firing, you can see a red dot with a number on the service. The number indicates how many alerts are firing for a specific service. To see the alerts, click <b>view alerts</b>.</li> | ||
<li>Configure the apdex settings by clicking the Edit icon next to the Apdex score.</li> | ||
</ul> | ||
</ul> | ||
</td> | ||
<td><img src="/images/service_map_focus_on_a_service.png" alt="Popup when you click on a service"/></td> | ||
</tr> | ||
</tbody> | ||
</table> | ||
|
||
### See Service Traffic Information | ||
|
||
<table style="width: 100%;"> | ||
<tbody> | ||
<tr> | ||
<td> | ||
When you click on the service traffic between the styling and printing service, you can: | ||
<ul><li>View Request, Error, and Duration (RED) metrics for the specific edge.</li> | ||
<li> Navigate to the Traces Browser by clicking <b>View Traces for This Traffic</b>. You don't see this option if you are using eBPF.</li> | ||
<li> Navigate to the Operation Dashboard to view RED metrics of the outbound and inbound operations by clicking <b>View Passenger Dashboard (Outbound Traffic)</b> or <b>View Trip Dashboard (Inbound Traffic)</b>.</li> | ||
</ul> | ||
</td> | ||
<td><img src="/images/service_map_tracing_traffic.png" alt="The pop up when you click a tracing traffic that is bidirectional"/></td> | ||
</tr> | ||
</tbody> | ||
</table> | ||
|
||
## Learn More! | ||
|
||
* [Learn how you can monitor your application using eBPF or tracing](application_monitoring_overview.html). | ||
* View the services on the [Services and Applications page](service_and_application_view.html). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.