Migrate

class perses_api.migrate.Migrate[source]

Bases: object

The class includes all necessary methods to access the Perses migration API

Parameters:

perses_api_model (APIModel) – Inject a Perses API model object that includes all necessary values and information

api

This is where we store the api

Type:

Api

__init__(perses_api_model: APIModel)[source]
migrate(grafana_dashboard: dict, migration_input: dict = None) → dict[source]

The method includes a functionality to migrate a Grafana dashboard to the Perses format

Parameters:

  • grafana_dashboard (dict) – Specify the Grafana dashboard JSON to migrate

  • migration_input (dict) – Specify additional migration input variables (default None)

Raises:

  • ValueError – Missed specifying a necessary value

  • Exception – Unspecified error by executing the API call

Returns:

The migrated Perses dashboard dict

Return type:

dict