Learn how to integrate metrics tools to DevOps Intelligence
Metrics are the life blood of Devrloper Operations. The ability to measure productivity, the health of resources, up time and recovery is critical to both efficiency and effectiveness. How well teams work together and their ability to achieve service levels at each DevOps phase and the transition management from phase to phase are dependent on metric feedback.
DevOps Intelligence directly supports specific metrics tools
out of the box
, but also supports your ability to integrate your own tools that are not supported directly. Subsequent sections provide information to perform this integration.
Integrating Plan metrics tools
Add your Planning tool:
Create or Edit an application in Application manager.
Go to add Tool Configuration page.
Select Plan.
Click on
Add Tool Configuration
button.
Select the
Tool Category
as
Bring your own tool
option.
Provide a BYO tool name and save the configuration.
Click
Submit
.
Generate a Token. You must generate the token before posting data to DevOps Intelligence. Use any REST client tool.
End Point: http://your_tenant_host/dash/api/insightscontroller/v1/config/tokens
Method: POST
Body:
Use the token generated in
step 2
to post the data:
End Point: http://<your_tenant_host>/dash/api/insightscontroller/v1/issueSnapshot/dash/api/insightscontroller/v1/issueSnapshot
Method: POST
Header: authorization: <service_token>
Body:
Verify that data is displayed in
DevOps Performance Metrics
dashboard.
Integrating Develop metrics tools
Use the
Integrating Plan metrics tools
procedure but post the data in accordance with the type of endpoint:
Commits
Issues
Pull requests
End Points for Commits
End Point: https://your_tenant_host/dash/api/application/{applicationName}/technical-services/{technicalServiceName}/tool/{toolName}/commits/dash/api/application/{applicationName}/technical-services/{technicalServiceName}/tool/{toolName}/commits
End Point: https://your_tenant_host/dash/api/application/{applicationName}/technical-services/{technicalServiceName}/tool/{toolName}/pullrequests/dash/api/application/{applicationName}/technical-services/{technicalServiceName}/tool/{toolName}/pullrequests
Method: POST
Header: authorization: <service_token>
Body:
Verify that data is displayed in
DevOps Performance Metrics
dashboard.
Integrating Build metrics tools
Use the following procedure to integrate your Build metrics tools:
Create or Edit an application in Application manager.
Go to add Tool Configuration page.
Select the build phase.
Click on
Add Tool Configuration
button.
Select the
Tool Category
as
Bring your own tool
option.
Turn on
Existing Tool From Mapper
.
Select the tool from existing mapper.
Configure the required
Release and Severity
details accordingly the phase and tool engine selected. By default,
Existing Tool From Mapper
will be turned off so that you can provide a BYO tool name.
Enter a tool name.
Select an existing tool from the Mapper.
Complete the form, providing details for the Mapper.
Click
Save
.
Click
Submit
.
Generate a token: Generate a Token. You must generate the token before posting data to DevOps Intelligence. Use any REST client tool.
End Point: http://your_tenant_host/dash/api/insightscontroller/v1/config/tokens
Method: POST
Body:
Post the data, by providing End Points for Generic Builds:
End Point: https://<your_tenant_host>/dash/api/application/{applicationName}/technical-services/{technicalServiceName}/tool/{toolName}/generic-builds/dash/api/application/{applicationName}/technical-services/{technicalServiceName}/tool/{toolName}/generic-builds
Method: POST
Header: authorization: <service_token>
Verify that data is displayed in
DevOps Performance Metrics
dashboard.
Integrating Secure metrics tools
Use the
Integrating Build metrics tools
procedure to integrate Secure metrics tools but post the data in accordance with the type of endpoint:
Static Scan
License Scan
Vulnerability Scan
Dependency Check
Static Scan
End Point: https://<your_tenant_host>/dash/api/v4/static-scan/application/{applicationName}/technical-services/{technicalServiceName}/tool/{toolName}/vulnerabilities
Method: POST
Header: authorization: <service_token>
Body:
End Point: https://<your_tenant_host>/dash/api/v4/static-scan/application/{applicationName}/technical-services/{technicalServiceName}/tool/{toolName}/generic-vulnerabilities
Method: POST
Header: authorization: <service_token>
License Scan
End Point: https://<your_tenant_host>/dash/api/application/{applicationName}/technical-services/{technicalServiceName}/tool/{toolName}/vulnerabilities
Method: POST
Header: authorization: <service_token>
Body:
End Point: https://<your_tenant_host>/dash/api/application/{applicationName}/technical-services/{technicalServiceName}/tool/{toolName}/generic-vulnerabilities
Method: POST
Header: authorization: <service_token>
Container Vulnerability Scan
End Point: https://<your_tenant_host>/dash/api/v4/image-scan/application/{applicationName}/technical-services/{technicalServiceName}/tool/{toolName}/vulnerabilities
Method: POST
Header: authorization: <service_token>
Body:
End Point: https://<your_tenant_host>/dash/api/v4/image-scan/application/{applicationName}/technical-services/{technicalServiceName}/tool/{toolName}/generic-vulnerabilities
Method: POST
Header: authorization:<service_token>
Dependency Check
End Point: https://<your_tenant_host>/dash/api/v4/dependency-check/application/{applicationName}/technical-services/{technicalServiceName}/tool/{toolName}/vulnerabilities
Method: POST
Header: authorization: <service_token>
Body:
End Point: https://<your_tenant_host>/dash/api/v4/dependency-check/application/{applicationName}/technical-services/{technicalServiceName}/tool/{toolName}/generic-vulnerabilities
Method: POST
Header: authorization: <service_token>
Verify that data is displayed in
DevOps Performance Metrics
dashboard.
Integrating Test metrics tools
Use the
Integrating Build metrics tools
procedure to integrate Secure metrics tools but post the data in accordance with Test tools requirements:
File upload: Upload the automation xml file output as of automation. As test type is unit in above api call.
Verify that data is displayed in the
Test
dashboard.
Bring Your Own Deploy
Use the procedure for integrating Build metrics tools to integrate Secure metrics tools but post the data in accordance with Deploy tools requirements:
Endpoints for Deployment
End Point: https://<your_tenant_host>/dash/api/application/{applicationName}/technical-services/{technicalServiceName}/tool/{toolName}/deployments
Method: POST
Header: authorization: <service_token>
Body:
Endpoints for Generic deployment
End Point: https://<your tenant_host>/dash/api/application/{applicationName}/technical-services/{technicalServiceName}/tool/{toolName}/generic-deployments
Method: POST
Header: authorization: <service_token>
Verify that data is getting displayed in
DevOps Performance Metrics
dashboard.
Bring Your Own Monitor
Use the procedure for integrating Build metrics tools to integrate Secure metrics tools but post the data in accordance with Monitor tools requirements:
Endpoints for Incidents
End Point: https://<your_tenant_host>/dash/api/application/{applicationName}/technical-services/{technicalServiceName}/tool/{toolName}/incidents
Method: POST
Header: authorization: <service_token>
Body:
Endpoints for Generic Incidents:
End Point: https://<your_tenant_host/dash/api/application/{applicationName}/technical-services/{technicalServiceName}/tool/{toolName}/generic-incident
Method: POST
Header: authorization: <service_token>
Verify that data is displayed in
DevOps Performance Metrics
dashboard.
Bring Your Own CLT
Use the
Integrating Plan metrics tools
procedure but post the data in accordance with your CLT:
End Point: https://<your_tenant_host>/dash/api/insightscontroller/v1/issueSnapshot
Method: POST
Header: authorization: <service_token>
Body:
Verify that data is displayed in
DevOps Performance Metrics
dashboard.
Deleting your Bring Your Own Metrics tools
Use the following procedure to delete individual bring your own metrics tools:
For deleting the metrics, select the phase in the application.