/* * Datadog API for Go * * Please see the included LICENSE file for licensing information. * * Copyright 2013 by authors and contributors. */ package datadog import ( "encoding/json" "fmt" ) // GraphDefinitionRequest represents the requests passed into each graph. type GraphDefinitionRequest struct { Query string `json:"q"` Stacked bool `json:"stacked"` Aggregator string ConditionalFormats []DashboardConditionalFormat `json:"conditional_formats,omitempty"` Type string `json:"type,omitempty"` Style *struct { Palette *string `json:"palette,omitempty"` Width *string `json:"width,omitempty"` Type *string `json:"type,omitempty"` } `json:"style,omitempty"` // For change type graphs ChangeType string `json:"change_type,omitempty"` OrderDirection string `json:"order_dir,omitempty"` CompareTo string `json:"compare_to,omitempty"` IncreaseGood bool `json:"increase_good,omitempty"` OrderBy string `json:"order_by,omitempty"` ExtraCol string `json:"extra_col,omitempty"` } type GraphDefinitionMarker struct { Type string `json:"type"` Value string `json:"value"` Label string `json:"label,omitempty"` Val json.Number `json:"val,omitempty"` Min json.Number `json:"min,omitempty"` Max json.Number `json:"max,omitempty"` } // Graph represents a graph that might exist on a dashboard. type Graph struct { Title string `json:"title"` Definition struct { Viz string `json:"viz"` Requests []GraphDefinitionRequest `json:"requests"` Events []struct { Query string `json:"q"` } `json:"events"` Markers []GraphDefinitionMarker `json:"markers,omitempty"` // For timeseries type graphs Yaxis struct { Min *float64 `json:"min,omitempty"` Max *float64 `json:"max,omitempty"` Scale *string `json:"scale,omitempty"` } `json:"yaxis,omitempty"` // For query value type graphs Autoscale bool `json:"austoscale,omitempty"` TextAlign string `json:"text_align,omitempty"` Precision string `json:"precision,omitempty"` CustomUnit string `json:"custom_unit,omitempty"` // For hostnamp type graphs Style *struct { Palette *string `json:"palette,omitempty"` PaletteFlip *bool `json:"paletteFlip,omitempty"` } Groups []string `json:"group,omitempty"` IncludeNoMetricHosts bool `json:"noMetricHosts,omitempty"` Scopes []string `json:"scope,omitempty"` IncludeUngroupedHosts bool `json:"noGroupHosts,omitempty"` } `json:"definition"` } // Template variable represents a template variable that might exist on a dashboard type TemplateVariable struct { Name string `json:"name"` Prefix string `json:"prefix"` Default string `json:"default"` } // Dashboard represents a user created dashboard. This is the full dashboard // struct when we load a dashboard in detail. type Dashboard struct { Id int `json:"id"` Description string `json:"description"` Title string `json:"title"` Graphs []Graph `json:"graphs"` TemplateVariables []TemplateVariable `json:"template_variables,omitempty"` ReadOnly bool `json:"read_only"` } // DashboardLite represents a user created dashboard. This is the mini // struct when we load the summaries. type DashboardLite struct { Id int `json:"id,string"` // TODO: Remove ',string'. Resource string `json:"resource"` Description string `json:"description"` Title string `json:"title"` } // reqGetDashboards from /api/v1/dash type reqGetDashboards struct { Dashboards []DashboardLite `json:"dashes"` } // reqGetDashboard from /api/v1/dash/:dashboard_id type reqGetDashboard struct { Resource string `json:"resource"` Url string `json:"url"` Dashboard Dashboard `json:"dash"` } type DashboardConditionalFormat struct { Palette string `json:"palette,omitempty"` Comparator string `json:"comparator,omitempty"` CustomBgColor string `json:"custom_bg_color,omitempty"` Value json.Number `json:"value,omitempty"` Inverted bool `json:"invert,omitempty"` CustomFgColor string `json:"custom_fg_color,omitempty"` } // GetDashboard returns a single dashboard created on this account. func (client *Client) GetDashboard(id int) (*Dashboard, error) { var out reqGetDashboard if err := client.doJsonRequest("GET", fmt.Sprintf("/v1/dash/%d", id), nil, &out); err != nil { return nil, err } return &out.Dashboard, nil } // GetDashboards returns a list of all dashboards created on this account. func (client *Client) GetDashboards() ([]DashboardLite, error) { var out reqGetDashboards if err := client.doJsonRequest("GET", "/v1/dash", nil, &out); err != nil { return nil, err } return out.Dashboards, nil } // DeleteDashboard deletes a dashboard by the identifier. func (client *Client) DeleteDashboard(id int) error { return client.doJsonRequest("DELETE", fmt.Sprintf("/v1/dash/%d", id), nil, nil) } // CreateDashboard creates a new dashboard when given a Dashboard struct. Note // that the Id, Resource, Url and similar elements are not used in creation. func (client *Client) CreateDashboard(dash *Dashboard) (*Dashboard, error) { var out reqGetDashboard if err := client.doJsonRequest("POST", "/v1/dash", dash, &out); err != nil { return nil, err } return &out.Dashboard, nil } // UpdateDashboard in essence takes a Dashboard struct and persists it back to // the server. Use this if you've updated your local and need to push it back. func (client *Client) UpdateDashboard(dash *Dashboard) error { return client.doJsonRequest("PUT", fmt.Sprintf("/v1/dash/%d", dash.Id), dash, nil) }