Skip to content

Improvements from 4.5.0 beta testing #9058

New issue

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

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

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: 4.5.0
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
33 changes: 33 additions & 0 deletions en/docs/api-analytics/analytics-overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# API Manager Analytics

API Manager analytics provides insights into the API usage, performance, and other key metrics to help API publishers and consumers make informed decisions. The analytics dashboard provides a comprehensive view of the API traffic, user engagement, and other relevant data. This section provides an overview of the analytics features available in WSO2 API Manager and guidance on how to use them effectively.

## Architecture

<a href="{{base_path}}/assets/img/analytics/analytics-architecture.png" >
<img src="{{base_path}}/assets/img/analytics/analytics-architecture.png" alt="APIM Analytics Architecture"/>
</a>

Analytics architecture consists with the following components

- **Inbound Analytics**
- **Outbound Analytics**
- **AI Analytics**

### Inbound Analytics

As above diagram shows, Inbound Analytics consists with analytics data that are collected between the user and API Proxy. This includes apiContext, proxyResponseCode, proxyResponseCode, apiType etc.

### Outbound Analytics

Outbound Analytics consists with analytics data that are collected between the API Proxy and the backend service. This includes targetResponseCode, backendLatency, destination etc.

### AI Analytics

AI Analytics shows the Outbound analytics data that are specific to AI APIs. This includes aiTokenUsage, vendorName, vendorVersion, model, promptTokens, completionTokens and totalTokens.

WSO2 API Manager supports multiple platforms to monitor and analyze API traffic. This includes:

- [**Choreo Analytics**](choreo-analytics/api-analytics-architecture.md) - A SaaS based API analytics platform that provides real-time insights into API traffic, performance, and user engagement.
- [**ELK Base Analytics Solution**](on-prem/elk-installation-guide.md) - Native support for Elasticsearch, Logstash, and Kibana (ELK) stack to monitor and analyze API traffic.
- [**DataDog Based Analytics Solution**](on-prem/datadog-installation-guide.md) - Integration with DataDog to monitor and analyze API traffic.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Adding Dynamic Endpoints

You cannot dynamically construct the back-end endpoint of an API using the address endpoints in the WSO2 API Manager. To achieve the requirement of a dynamic endpoint, you can use the default endpoint instead.
In WSO2 API Manager, while address endpoints are static, you can achieve dynamic backend endpoint functionality effortlessly by using the default endpoint.

[![Dynamic Endpoints]({{base_path}}/assets/img/learn/api-gateway/message-mediation/dynamic-endpoints.png)]({{base_path}}/assets/img/learn/api-gateway/message-mediation/dynamic-endpoints.png)

Expand Down
Loading