Instrument Terraform usage of GitLab APIs
Problem to solve
As a Configure Group member, I would like to know what GitLab APIs are access with Terraform so we can focus our attention accordingly.
We would like to measure the usage of various GitLab APIs accessed specifically by the GitLab Terraform Provider or by go-gitlab.
Intended users
Actually, everyone using Terraform with GitLab would benefit from this feature.
- Cameron (Compliance Manager)
- Delaney (Development Team Lead)
- Sasha (Software Developer)
- Devon (DevOps Engineer)
- Sidney (Systems Administrator)
- Allison (Application Ops)
- Priyanka (Platform Engineer)
User experience goal
Create a visualisation (Kibana or SiSense) like https://log.gprd.gitlab.net/app/kibana#/discover/50ee11c0-f0f3-11ea-81e5-155ba78758d4?_g=h@c823129&_a=h@6a684ef
but grouping by the 3rd segment onward of the api path leaving out the use-specific arguments. Like instead of /api/v4/projects/1234/members/5678
it should be projects//members/
(drop the common part from the beginning, and replace numbers with empty strings).
Proposal
- We might get the above visualisation for
go-gitlab
with a custom, scripted field under https://log.gprd.gitlab.net - We could start collecting Terraform specific data by changing the user agent string in the GitLab Terraform provider. Currently, the provider does not overwrite the default
go-gitlab
username.
useragent string will look like: HashiCorp Terraform/0.13.4 (+https://www.terraform.io) Terraform Plugin SDK/1.15.0 terraform-provider-gitlab
Further details
Permissions and Security
Documentation
Availability & Testing
What does success look like, and how can we measure that?
What is the type of buyer?
Is this a cross-stage feature?
Links / references
This page may contain information related to upcoming products, features and functionality. It is important to note that the information presented is for informational purposes only, so please do not rely on the information for purchasing or planning purposes. Just like with all projects, the items mentioned on the page are subject to change or delay, and the development, release, and timing of any products, features, or functionality remain at the sole discretion of GitLab Inc.