Compass metricSourceId add to config-as-code or api call

Phill Pafford

So I'm trying to figure out the best way to store or get the 

metricSourceId for each metric configured on my component. Some options I've thought of

• manually add them to the config-as-code file, BTW this would be a useful add if this was automated
• curl api call to get all configured metrics for a given component 

I'm running datacenter and everything needs to be done manually, so just trying to think about the best way to implement, since there is little support for datacenter and compass integration

If I could choose, please make it an API call so I can get a current list of all metrics configured

 

example api request: 

curl --request GET \ 
   --url https://acme.atlassian.net/gateway/api/compass/v1/metrics/${component_id} \ 
   --user "$USER_EMAIL:$USER_API_KEY" \ 
   --header "Accept: application/json" \ 
   --header "Content-Type: application/json" 

 

example config-as-code:  

name: my-api
id: 'ari:cloud:compass:12j3hg123jhg123hj:component/34io5u34oi5u3oi4u534/324klj34kjl4jl3k4j'
metrics:
 - name: build time
   metricId: 'ari:cloud:compass:12j3hg123jhg123hjg123:metric-source/34io5u34oi5u3oi4u534/kwpoerkekmfemcpeck23\'

 

Emile Raffoul

Hi @Phill Pafford ,

Thanks for reaching out!

There is currently a GraphQL API where you can provide a component ID and request all the metricSources for that component.

The full API reference can be found here but here's an example GraphQL request body also:

query getComponentDetails($id: ID!) {
  compass {
    component(id: $id) {
      ... on CompassComponent {
        metricSources {
          ...on CompassComponentMetricSourcesConnection {
            nodes {
              id
            }
          }
        }
      }
    }
  }
}

And providing the input variables:

{
  "id": "yourComponentId"
}

In this query I'm only returning the metricSource IDs but you can add extra fields to the query such as the metricDefinition and name also.

Would this work for your use case?