Module: Grafana::Snapshot

Included in:
Client
Defined in:
lib/grafana/snapshot.rb

Overview

docs.grafana.org/http_api/snapshot/

Instance Method Summary collapse

Instance Method Details

#create_snapshot(dashboard = {}) ⇒ Object

Create new snapshot POST /api/snapshots

Raises:

  • (ArgumentError) 


22
23
24
25
26
27
28
29
30
 
# File 'lib/grafana/snapshot.rb', line 22

def create_snapshot( dashboard = {} )

  raise ArgumentError.new('dashboard must be an Hash') unless( dashboard.is_a?(String) )

  endpoint = '/api/snapshot'
  @logger.debug("Creating dashboard snapshot (POST #{endpoint})") if @debug

  post(endpoint, dashboard)
end

#delete_snapshot(key) ⇒ Object

Delete Snapshot by Id GET /api/snapshots-delete/:key

Raises:

  • (ArgumentError) 


35
36
37
38
39
40
41
42
43
 
# File 'lib/grafana/snapshot.rb', line 35

def delete_snapshot(key)

  raise ArgumentError.new('key must be an String') unless( key.is_a?(String) )

  endpoint = format( '/api/snapshots-delete/%s', key)
  @logger.debug("Deleting snapshot id #{key} (GET #{endpoint})") if @debug

  delete(endpoint)
end

#snapshot(key) ⇒ Object

Get Snapshot by Id GET /api/snapshots/:key

Raises:

  • (ArgumentError) 


10
11
12
13
14
15
16
17
18
 
# File 'lib/grafana/snapshot.rb', line 10

def snapshot(key)

  raise ArgumentError.new('key must be an String') unless( key.is_a?(String) )

  endpoint = format('/api/snapshot/%s', key)
  @logger.debug("Get Snapshot by Id #{key} (GET #{endpoint})") if @debug

  get(endpoint)
end