Class: Wavefront::Usage

Inherits:
CoreApi show all
Defined in:
lib/wavefront-sdk/usage.rb

Overview

View and manage Wavefront usage.

Ingestion policy shares this API path, but has its own SDK class.

Instance Attribute Summary

Attributes inherited from CoreApi

#api, #creds, #logger, #opts, #update_keys

Instance Method Summary collapse

Methods inherited from CoreApi

#api_base, #api_path, #hash_for_update, #initialize, #setup_api, #time_to_ms

Methods included from Mixins

#log, #parse_relative_time, #parse_time, #relative_time, #time_multiplier, #valid_relative_time?

Methods included from Validators

#uuid?, #wf_account_id?, #wf_alert_id?, #wf_alert_severity?, #wf_apitoken_id?, #wf_aws_external_id?, #wf_cloudintegration_id?, #wf_dashboard_id?, #wf_derivedmetric_id?, #wf_distribution?, #wf_distribution_count?, #wf_distribution_interval?, #wf_distribution_values?, #wf_epoch?, #wf_event_id?, #wf_granularity?, #wf_ingestionpolicy_id?, #wf_integration_id?, #wf_link_id?, #wf_link_template?, #wf_maintenance_window_id?, #wf_message_id?, #wf_metric_name?, #wf_metricspolicy_id?, #wf_monitoredcluster_id?, #wf_ms_ts?, #wf_name?, #wf_notificant_id?, #wf_permission?, #wf_point?, #wf_point_tag?, #wf_point_tags?, #wf_proxy_id?, #wf_role_id?, #wf_sampling_value?, #wf_savedsearch_entity?, #wf_savedsearch_id?, #wf_serviceaccount_id?, #wf_source_id?, #wf_string?, #wf_tag?, #wf_trace?, #wf_ts?, #wf_user_id?, #wf_usergroup_id?, #wf_value?, #wf_version?, #wf_webhook_id?

Constructor Details

This class inherits a constructor from Wavefront::CoreApi

Instance Method Details

#export_csv(t_start, t_end = nil) ⇒ Wavefront::Response

GET /api/v2/usage/exportcsv Export a CSV report

Parameters:

  • t_start (Integer) —

    start time in epoch seconds

  • t_end (Integer) (defaults to: nil) —

    end time in epoch seconds, nil being “now”.

Returns:



19
20
21
22
23
24
25
26
27
28
29
 
# File 'lib/wavefront-sdk/usage.rb', line 19

def export_csv(t_start, t_end = nil)
  wf_epoch?(t_start)
  args = { startTime: t_start }

  if t_end
    wf_epoch?(t_end)
    args[:endTime] = t_end
  end

  api.get('exportcsv', args)
end