Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

You should refer to the documentation about setting up API Usage Reporters within the Gateway here: Setting up API Gateway - here, we assume that you have configured the Ceptor Gateway to use Elasticsearch.

When

...

Is API Usage

...

Information Recorded

For API Usage information to be recorded, the gateway needs to be set up to store the information - e.g. within Elasticsearch.

...

See Setting up API Gateway for more details.

Viewing API Usage / Analytics

...

Information Within Ceptor Console

There are various methods of viewing API Usage information within Ceptor Console - the following assumes that Ceptor API Gateway is configured to use Elasticsearch to store API Usage information.

...

You will also see how which HTTP response codes were sent in how many calls (the top 10 list is displayed) and you can see which clients made the calls.



Viewing Elasticsearch

...

Data in Dashboards

If you need to do deeper analysis of your API calls, you can now use Elasticsearch as a datasource when defining Dashboards within Ceptor Console.

...