Ceptor API Usage
Store API Usage information in any level of detail, in any place you want to
Our API is open, so you can implement your custom plugins which get full access to all the internal data, including the full request and response.
It is possible to use multiple plugins at once, so you can choose to store full detail in Elasticsearch and overview information in the logs if you wish to do so.
API Usage Reporting
Ceptor API Gateway has plugins for providing custom API Usage Reporting repositories
With Ceptor API Gateway you have the flexibility to decide where to store API Usage information, it could be in Elasticsearch, databases, existing SIEM products or where you prefer to store the data – often large enterprises already have existing products for this sort of information that they prefer to reuse instead of requiring to learn yet another tool.
Once the Ceptor API Gateway is configured, all API calls will be recorded by the API Usage plugin. If you use Ceptor’s statistics to store API Usage information, you can create dashboards directly in Ceptor to visualize your data, or you can create PDF reports based upon the same data providing detailed SLA report to your business.
Using Ceptor’s API Usage Data
There are many different use cases that you can solve with Ceptor’s API Usage data
- Monitoring of APIs
Monitor your APIs, see which APIs are called by whom.
- Proxy Performance Monitoring
Monitor performance of Proxy / Gateway.
- (Micro)Service Performance Monitoring
Monitor the response time of your services.
- Detect Anomalies
Investigate peaks or dips in traffic and gain insight into surrounding traffic patterns.
- Top Devices
View which devices are consuming your APIs.
- Error Code Detection
Investigate errors sent from your services and view the input that generated the errors.
- Custom Reporting
Define your own custom reports on any of the provided metadata or request/response contents.
Collect the data for billing of your API usage to individual partners.
Audit complete request / response contents – some APIs might require comprehensive logging for legal purposes.
Use freely available tools like Kibana to visualize your data, create custom dashboards and combine Ceptor’s data with our existing datasources
API Usage Reporters
Ceptor is highly flexible and supports multiple different repositories for API Usage information
- API Usage Log
This API Usage plugin simply logs the call in the regular log using SLF4J which can then be redirected to a specific destination using regular log configuration.
It logs a brief overview of which partner and application calls what API / API Version, but with few details. Use this plugin if you are mainly interested in recording API usage information but do not care particularly about the details.
- API Usage Log JSON
Like API Usage Log– this plugin records API Usage information to the log, but instead of logging a text message, it logs a JSON message with the same content as the one used by the ElasticSearch API Usage log plugin. This enables you to use SLF4J/Logback appender to redirect the logging to any appropriate place, such as a database, syslog or any other destination supported by an SLF4j appender.
- API Usage Statistics
This API Usage plugin stores information about the call in Ceptor’s Statistics – this enables you to create graphs or PDF reports based on the data.
- API Usage Elasticsearch
This API Usage plugin stores information about the API Call in Elasticsearch – allowing storing full detail and allowing extensive data-mining on API calls to be made. Ceptor supports fully asynchronous logging, enabling high-volume and high-performance storing of data within an Elasticsearch cluster.