observability_dashboards

Creates, updates, deletes, gets or lists an observability_dashboards resource.

Overview

Name	observability_dashboards
Type	Resource
Id	railway.observability.observability_dashboards

Fields

The following fields are returned by SELECT queries:

list

One row per ObservabilityDashboard.

Name	Datatype	Description
id	string
items	array	List of ObservabilityDashboardItemInstance objects

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	environment_id		Get all observability dashboards for an environment. Backed by the Railway GraphQL query observabilityDashboards.
create	insert	environment_id		Create an observability dashboard. Backed by the Railway GraphQL mutation observabilityDashboardCreate.
update	update	id, input		Update an observability dashboard. Backed by the Railway GraphQL mutation observabilityDashboardUpdate.
reset	exec	id		Reset an observability dashboard to default dashboard items. Backed by the Railway GraphQL mutation observabilityDashboardReset.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
environment_id	string
id	string
input	array	JSON array of objects of GraphQL type ObservabilityDashboardUpdateInput; keys keep the API's camelCase names.

SELECT examples

list

Get all observability dashboards for an environment. Backed by the Railway GraphQL query observabilityDashboards.

SELECT
id,
items
FROM railway.observability.observability_dashboards
WHERE environment_id = '{{ environment_id }}' -- required
;

INSERT examples

create

Create an observability dashboard. Backed by the Railway GraphQL mutation observabilityDashboardCreate.

INSERT INTO railway.observability.observability_dashboards (
environment_id,
items
)
SELECT 
'{{ environment_id }}' /* required */,
'{{ items }}'
RETURNING
result
;

Manifest

# Description fields are for documentation purposes
- name: observability_dashboards
props:
  - name: environment_id
    value: "{{ environment_id }}"
  - name: items
    value: "{{ items }}"
    description: |
      If no items are provided, a default dashboard will be created. JSON array of objects of GraphQL type ObservabilityDashboardUpdateInput; keys keep the API's camelCase names.

UPDATE examples

update

Update an observability dashboard. Backed by the Railway GraphQL mutation observabilityDashboardUpdate.

UPDATE railway.observability.observability_dashboards
SET 

WHERE 
id = '{{ id }}' --required
AND input = '{{ input }}' --required
RETURNING
result;

Lifecycle Methods

reset

Reset an observability dashboard to default dashboard items. Backed by the Railway GraphQL mutation observabilityDashboardReset.

EXEC railway.observability.observability_dashboards.reset 
@id='{{ id }}' --required
;