WebService::DataDog::Dashboard - Interface to Dashboard functions in DataDog's API.
Version 0.8.0
This module allows you interact with the Dashboard endpoint of the DataDog API.
Per DataDog: "The Dashboards end point allow you to programmatically create, update delete and query dashboards."
Deprecated. Please use retrieve_all() instead.
Retrieve details for all user-created dashboards ( does not include system-generated or integration dashboards ).
my $dashboard = $datadog->build('Dashboard'); my $dashboard_list = $dashboard->retrieve_all();
Parameters: None
Deprecated. Please use retrieve() instead.
Retrieve details for specified user-created dashboards ( does not work for system-generated or integration dashboards ).
my $dashboard = $datadog->build('Dashboard'); my $dashboard_data = $dashboard->retrieve( id => $dash_id );
Parameters:
id
Id of dashboard you want to retrieve the details for.
Deprecated. Please use update() instead.
Update details for specified user-created dashboard ( does not work for system-generated or integration dashboards ). Supply at least one of the arguments 'title', 'description', 'graphs'. Any argument not supplied will remain unchanged within the dashboard.
WARNING: If you only specify a new graph to add to the dashboard, you WILL LOSE ALL EXISTING GRAPHS. Your 'graphs' section must include ALL graphs that you want to be part of a dashboard.
my $dashboard = $datadog->build('Dashboard'); $dashboard->update( id => $dash_id, title => $dash_title, description => $dash_description, graphs => $graphs, );
Id of dashboard you want to update.
title
Optional. Specify updated title for specified dashboard.
description
Optional. Specify updated description for specified dashboard.
graphs
Optional. Specify updated graph definition for specified dashboard.
Create new DataDog dashboard with 1+ graphs. If successful, returns created dashboard id.
my $dashboard = $datadog->build('Dashboard'); my $dashboard_id = $dashboard->create( title => $dash_title, description => $dash_description, graphs => $graphs, ); Example: my $new_dashboard_id = $dashboard->create( title => "TEST DASH", description => "test dashboard", graphs => [ { title => "Sum of Memory Free", definition => { events =>[], requests => [ { q => "sum:system.mem.free{*}" } ] }, viz => "timeseries" }, ], );
Specify title for new dashboard.
Specify description for new dashboard.
Specify graph definition for new dashboard.
Title of graph.
definition
Definition of graph.
events
Overlay any events from the event stream.
requests
Metrics you want to graph.
viz
Visualisation of graph. Valid values: timeseries (default), treemap.
Deprecated. Please use delete() instead.
Delete specified user-created dashboard. NOTE: You cannot remove system-generated or integration dashboards.
my $dashboard = $datadog->build('Dashboard'); $dashboard->delete( id => $dash_id );
Dashboard id you want to delete.
Common error checking for creating/updating dashboards.
Jennifer Pinkham, <jpinkham at cpan.org>.
<jpinkham at cpan.org>
Please report any bugs or feature requests to bug-WebService-DataDog at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=WebService-DataDog. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
bug-WebService-DataDog at rt.cpan.org
You can find documentation for this module with the perldoc command.
perldoc WebService::DataDog::Dashboard
You can also look for information at:
RT: CPAN's request tracker
http://rt.cpan.org/NoAuth/Bugs.html?Dist=WebService-DataDog
AnnoCPAN: Annotated CPAN documentation
http://annocpan.org/dist/WebService-DataDog
CPAN Ratings
http://cpanratings.perl.org/d/WebService-DataDog
Search CPAN
http://search.cpan.org/dist/WebService-DataDog/
Copyright 2013 Jennifer Pinkham.
This program is free software; you can redistribute it and/or modify it under the terms of the Artistic License.
See http://dev.perl.org/licenses/ for more information.
To install WebService::DataDog, copy and paste the appropriate command in to your terminal.
cpanm
cpanm WebService::DataDog
CPAN shell
perl -MCPAN -e shell install WebService::DataDog
For more information on module installation, please visit the detailed CPAN module installation guide.