Doc files for grafanim

grafanim

grafanim

Types

GrafanaClient = object
  cli: HttpClient
  url, key, user, pass: string

Procs

proc newGrafanaClient(host: string; port: int; user: string; pass: string): GrafanaClient {...}{.
    raises: [], tags: [].}
proc newGrafanaClient(host: string; port: int; key: string): GrafanaClient {...}{.raises: [],
    tags: [].}

Methods

method AdminSettings(self: GrafanaClient): JsonNode {...}{.base, raises: [ValueError,
    Exception, SslError, OSError, IOError, TimeoutError, ProtocolError, KeyError,
    Defect, OverflowError, JsonParsingError],
    tags: [ReadIOEffect, WriteIOEffect, TimeEffect].}
method Settings(self: GrafanaClient): JsonNode {...}{.base, raises: [ValueError, Exception,
    SslError, OSError, IOError, TimeoutError, ProtocolError, KeyError, Defect,
    OverflowError, JsonParsingError],
    tags: [ReadIOEffect, WriteIOEffect, TimeEffect].}
method Keys(self: GrafanaClient): JsonNode {...}{.base, raises: [ValueError, Exception,
    SslError, OSError, IOError, TimeoutError, ProtocolError, KeyError, Defect,
    OverflowError, JsonParsingError],
    tags: [ReadIOEffect, WriteIOEffect, TimeEffect].}
method Orgs(self: GrafanaClient): JsonNode {...}{.base, raises: [ValueError, Exception,
    SslError, OSError, IOError, TimeoutError, ProtocolError, KeyError, Defect,
    OverflowError, JsonParsingError],
    tags: [ReadIOEffect, WriteIOEffect, TimeEffect].}
method Users(self: GrafanaClient): JsonNode {...}{.base, raises: [ValueError, Exception,
    SslError, OSError, IOError, TimeoutError, ProtocolError, KeyError, Defect,
    OverflowError, JsonParsingError],
    tags: [ReadIOEffect, WriteIOEffect, TimeEffect].}
method Dashboard(self: GrafanaClient; dashboard: string): JsonNode {...}{.base, raises: [
    ValueError, Exception, SslError, OSError, IOError, TimeoutError, ProtocolError,
    KeyError, Defect, OverflowError, JsonParsingError],
    tags: [ReadIOEffect, WriteIOEffect, TimeEffect].}
method Dashboards(self: GrafanaClient): JsonNode {...}{.base, raises: [ValueError,
    Exception, SslError, OSError, IOError, TimeoutError, ProtocolError, KeyError,
    Defect, OverflowError, JsonParsingError],
    tags: [ReadIOEffect, WriteIOEffect, TimeEffect].}
method DashboardTags(self: GrafanaClient): JsonNode {...}{.base, raises: [ValueError,
    Exception, SslError, OSError, IOError, TimeoutError, ProtocolError, KeyError,
    Defect, OverflowError, JsonParsingError],
    tags: [ReadIOEffect, WriteIOEffect, TimeEffect].}
method SearchDashboards(self: GrafanaClient; query: string; tag: string = "";
                       starred = false; tagcloud = false): JsonNode {...}{.base, raises: [
    ValueError, Exception, SslError, OSError, IOError, TimeoutError, ProtocolError,
    KeyError, Defect, OverflowError, JsonParsingError],
    tags: [ReadIOEffect, WriteIOEffect, TimeEffect].}
method Datasources(self: GrafanaClient): JsonNode {...}{.base, raises: [ValueError,
    Exception, SslError, OSError, IOError, TimeoutError, ProtocolError, KeyError,
    Defect, OverflowError, JsonParsingError],
    tags: [ReadIOEffect, WriteIOEffect, TimeEffect].}
method Datasource(self: GrafanaClient; id: int): JsonNode {...}{.base, raises: [ValueError,
    Exception, SslError, OSError, IOError, TimeoutError, ProtocolError, KeyError,
    Defect, OverflowError, JsonParsingError],
    tags: [ReadIOEffect, WriteIOEffect, TimeEffect].}
method Datasource(self: GrafanaClient; name: string): JsonNode {...}{.base, raises: [
    ValueError, Exception, SslError, OSError, IOError, TimeoutError, ProtocolError,
    KeyError, Defect, OverflowError, JsonParsingError],
    tags: [ReadIOEffect, WriteIOEffect, TimeEffect].}
method DatasourceId(self: GrafanaClient; name: string): JsonNode {...}{.base, raises: [
    ValueError, Exception, SslError, OSError, IOError, TimeoutError, ProtocolError,
    KeyError, Defect, OverflowError, JsonParsingError],
    tags: [ReadIOEffect, WriteIOEffect, TimeEffect].}
method NewDashboard(self: GrafanaClient; opts: JsonNode): JsonNode {...}{.base, gcsafe, raises: [
    ValueError, Exception, SslError, OSError, IOError, TimeoutError, ProtocolError,
    KeyError, Defect, OverflowError, JsonParsingError],
    tags: [ReadIOEffect, WriteIOEffect, TimeEffect].}
method NewInfluxDBDatasource(self: GrafanaClient; opts: JsonNode): JsonNode {...}{.base,
    gcsafe, raises: [ValueError, Exception, SslError, OSError, IOError, TimeoutError,
                   ProtocolError, KeyError, Defect, OverflowError, JsonParsingError],
    tags: [ReadIOEffect, WriteIOEffect, TimeEffect].}