Analytics endpoint commands
Analytics endpoint mode provides the commands to create or modify an API analytics endpoint.
To enter analytics endpoint mode, use the global analytics-endpoint command. To delete an analytics endpoint, use the no analytics-endpoint command.
While in this mode, use the commands in the following table to define the analytics endpoint.
- To view the current configuration, use the show command.
- To restore default values, use the reset command.
- To exit this configuration mode without saving changes to the running configuration, use the cancel command.
- To exit this configuration mode and save changes to the running configuration, use the exit command.
| Command | Purpose |
|---|---|
| adaptive-mode | This command specifies whether memory usage dynamically controls the maximum size of analytics records. |
| admin-state | This command sets the administrative state for the configuration. |
| analytics-server-url | This command specifies the URL to offload the collected API event data. |
| client-secret-alias | This command specifies the password alias for the client secret for the management platform endpoint. |
| clientid | This command specifies the client ID for the management platform endpoint. |
| delivery-connections | This command specifies the number of connections to establish per delivery to the remote server to offload analytics data. |
| enable-jwt | This command specifies whether to use JWT security to send API event data to the analytics server. |
| interval | This command specifies the interval between offloads of analytics data. |
| grant-type | This command specifies the grant type for requesting JWT tokens. |
| management-ssl-client | This command specifies the TLS client profile to secure connections with the management platform endpoint to retrieve the JWT. |
| management-url | This command specifies the URL of the management platform endpoint to retrieve the JWT. |
| max-records | This command specifies the maximum number of records that can be buffered for each API gateway. |
| max-record-size | This command specifies the maximum size for each record. |
| max-delivery-size | This command specifies the maximum size for each delivery of analytics data. |
| memory-threshold | This command specifies the alarm threshold when the analytics endpoint is operating in adaptive mode. |
| persistent-connection | This command controls the negotiation of persistent connections between the analytics endpoint and the remote server. |
| persistent-timeout | This command specifies the duration for persistent connections between the analytics endpoint and the remote server. |
| request-topic | This command specifies the name of the Kafka request topic to offload analytics data. |
| scope | This command specifies the scope for requesting JWT tokens. |
| ssl-client | This command associates a TLS client profile to secure connections with the analytics endpoint. |
| timeout | This command specifies the duration for connections between the analytics endpoint and the remote server. |
| summary | This command specifies the brief, descriptive summary for the object instance. |