Add Metrics Dashboard annnotations API to FF (!120286) · Merge requests · GitLab.org / GitLab

Merged Sarah Yasonik requested to merge sy-flag-metrics-annotations into master 1 year ago

What does this MR do and why?

This MR gates the metrics dashboard annotations API behind the remove_monitor_metrics feature flag. Frontend is done, but we also want to deprecate/remove any API access.

Context for removal:

The Metrics Dashboard feature is being removed in %16.0.
- Feature docs: https://docs.gitlab.com/ee/operations/metrics
- Removal issue: Monitor: Metrics Deprecation and Removal (&10107 - closed)
Most of the metrics dashboard frontend is currently behind the remove_monitor_metrics flag, but the flag has not yet been enabled. It needs to be enabled by default in time for %16.0.
- The entire frontend should be behind the flag in order to enable it by default, but the API can merge after - as long as we make all breaking changes within %16.0.
- Rollout issue: https://gitlab.com/gitlab-org/gitlab/-/issues/399248+
- Tracking issue: Metrics: hide deprecated modules behind a featu... (#399231 - closed)
- Enable-by-default MR: Set remove_monitor_metrics flag to true (!119989 - merged)

All related backend MRs to flag all metrics dashboard endpoints

How to set up and validate locally

Pre-req: Project with environments

Use graphiql to test the query -> http://gdk.test:3000/-/graphql-explorer
We can verify the flag without annotations actually set up, because the response attribute will switch from [] to null or error

Query Response before Response after

Query	Response before	Response after
`query annotations { project(fullPath: "gitlab-org/monitor/monitor-sandbox") { environments { nodes { metricsDashboard(path: "config/prometheus/common_metrics.yml") { annotations(from: "2023-05-09 11:57:31 -0400", to: "2023-05-10 11:57:31 -0400") { nodes { id panelId description } } } } } } }`	`{ "data": { "project": { "environments": { "nodes": [ { "metricsDashboard": { "annotations": { "nodes": [] } } } ] } } } }`	`{ "data": { "project": { "environments": { "nodes": [ { "metricsDashboard": { "annotations": null } } ] } } } }`
`mutation otherannotations { createAnnotation( input: { environmentId: "gid://gitlab/Environment/1", dashboardPath: "config/prometheus/common_metrics.yml", startingAt: "2023-05-09 11:57:31 -0400", description: "Something happened!" } ) { annotation { id description } } }`	`{ "data": { "createAnnotation": { "annotation": { "id": "gid://gitlab/Metrics::Dashboard::Annotation/1", "description": "Something happened!" } } } }`	`{ "data": { "createAnnotation": null }, "errors": [ { "message": "The resource that you are attempting to access does not exist or you don't have permission to perform this action", "locations": [ { "line": 21, "column": 3 } ], "path": [ "createAnnotation" ] } ] }`
`mutation deleteannotations { deleteAnnotation(input: { id: "gid://gitlab/Metrics::Dashboard::Annotation/2" }) { errors } }`	`{ "data": { "deleteAnnotation": { "errors": [] } } }`	`{ "data": { "deleteAnnotation": null }, "errors": [ { "message": "The resource that you are attempting to access does not exist or you don't have permission to perform this action", "locations": [ { "line": 37, "column": 3 } ], "path": [ "deleteAnnotation" ] } ] }`

query annotations {
  project(fullPath: "gitlab-org/monitor/monitor-sandbox") {
    environments {
      nodes {
        metricsDashboard(path: "config/prometheus/common_metrics.yml") {
          annotations(from: "2023-05-09 11:57:31 -0400", to: "2023-05-10 11:57:31 -0400") {
            nodes {
              id
              panelId
              description
            }
          }
        }
      }
    }
  }
}

{
  "data": {
    "project": {
      "environments": {
        "nodes": [
          {
            "metricsDashboard": {
              "annotations": {
                "nodes": []
              }
            }
          }
        ]
      }
    }
  }
}

{
  "data": {
    "project": {
      "environments": {
        "nodes": [
          {
            "metricsDashboard": {
              "annotations": null
            }
          }
        ]
      }
    }
  }
}

mutation otherannotations {
  createAnnotation(
    input: { 
      environmentId: "gid://gitlab/Environment/1",  
      dashboardPath: "config/prometheus/common_metrics.yml", 
      startingAt: "2023-05-09 11:57:31 -0400", 
      description: "Something happened!"
    }
  ) {
    annotation {
      id
      description
    }
  }
}

{
  "data": {
    "createAnnotation": {
      "annotation": {
        "id": "gid://gitlab/Metrics::Dashboard::Annotation/1",
        "description": "Something happened!"
      }
    }
  }
}

{
  "data": {
    "createAnnotation": null
  },
  "errors": [
    {
      "message": "The resource that you are attempting to access does not exist or you don't have permission to perform this action",
      "locations": [
        {
          "line": 21,
          "column": 3
        }
      ],
      "path": [
        "createAnnotation"
      ]
    }
  ]
}

mutation deleteannotations {
  deleteAnnotation(input: { id: "gid://gitlab/Metrics::Dashboard::Annotation/2" }) {
    errors
  }
}

{
  "data": {
    "deleteAnnotation": {
      "errors": []
    }
  }
}

{
  "data": {
    "deleteAnnotation": null
  },
  "errors": [
    {
      "message": "The resource that you are attempting to access does not exist or you don't have permission to perform this action",
      "locations": [
        {
          "line": 37,
          "column": 3
        }
      ],
      "path": [
        "deleteAnnotation"
      ]
    }
  ]
}

MR acceptance checklist

This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

I have evaluated the MR acceptance checklist for this MR.

Edited 1 year ago by Peter Leitzen

Activity

Please register or sign in to reply

Add Metrics Dashboard annnotations API to FF