SwaggerHub
SwaggerHub Usage Monitoring
About SwaggerHub
SwaggerHub is an API design and development platform built on the OpenAPI Specification. It helps teams collaborate on API design, documentation, and versioning. Monitoring SwaggerHub usage is important for ensuring that licenses are allocated to active users and for optimizing costs. This is similar to monitoring other development tools like GitLab or JetBrains Cloud.
Prerequisites
To begin monitoring SwaggerHub, ensure you have the following components and permissions in place:
- OpenLM Components: OpenLM Cloud Broker and OpenLM SLM are required.
- Platform-specific Requirements: You'll need administrative access to your SwaggerHub account to generate a personal access token with the necessary read permissions.
Configuring data collection
Follow these step-by-step instructions to set up data collection for SwaggerHub in OpenLM Cloud Broker:
- Enable API Access: In your SwaggerHub account settings, create a personal access token with read access to user and organization data.
- Add Credentials: In the OpenLM Cloud Broker dashboard, find the SwaggerHub integration and enter the access token.
- Verify Connection: Test the connection to ensure that OpenLM can successfully retrieve data.
- Approve in OpenLM: Approve the new data source within the License Servers section.
- See Data: Usage data for SwaggerHub will now be visible in the OpenLM Allocation service.
Viewing reports
Access your reports to analyze usage patterns.
- User Activity Trends: See which users are most active in the platform, helping you manage resource allocation.
- Expired/Unused License Reports: Identify and reclaim licenses from inactive users.