Uses of Class
io.nosqlbench.engine.clients.grafana.transfer.GAnnotation

Packages that use GAnnotation
Package
Description
io.nosqlbench.engine.clients.grafana
 
io.nosqlbench.engine.clients.grafana.analyzer
 

  • Uses of GAnnotation in io.nosqlbench.engine.clients.grafana

    Methods in io.nosqlbench.engine.clients.grafana that return GAnnotation
    Modifier and Type
    Method
    Description
    GAnnotation
    GrafanaClient.createAnnotation(GAnnotation gAnnotation)
    POST /api/annotations Example Request: POST /api/annotations HTTP/1.1 Accept: application/json Content-Type: application/json { "dashboardId":468, "panelId":1, "time":1507037197339, "timeEnd":1507180805056, "tags":["tag1","tag2"], "text":"Annotation Description" } Example Response: HTTP/1.1 200 Content-Type: application/json { "message":"Annotation added", "id": 1, }
    GAnnotation
    GrafanaClient.createGraphiteAnnotation()
    POST /api/annotations/graphite Example Request: POST /api/annotations/graphite HTTP/1.1 Accept: application/json Content-Type: application/json { "what": "Event - deploy", "tags": ["deploy", "production"], "when": 1467844481, "data": "deploy of master branch happened at Wed Jul 6 22:34:41 UTC 2016" } Example Response: HTTP/1.1 200 Content-Type: application/json { "message":"Graphite annotation added", "id": 1 }
    Methods in io.nosqlbench.engine.clients.grafana that return types with arguments of type GAnnotation
    Modifier and Type
    Method
    Description
    List<GAnnotation>
    GrafanaClient.findAnnotations(By... by)
    GET /api/annotations?from=1506676478816&to=1507281278816&tags=tag1&tags=tag2&limit=100 Example Request: GET /api/annotations?from=1506676478816&to=1507281278816&tags=tag1&tags=tag2&limit=100 HTTP/1.1 Accept: application/json Content-Type: application/json Authorization: Basic YWRtaW46YWRtaW4= Query Parameters: from: epoch datetime in milliseconds. Optional. to: epoch datetime in milliseconds. Optional. limit: number. Optional - default is 100. Max limit for results returned. alertId: number. Optional. Find annotations for a specified alert. dashboardId: number. Optional. Find annotations that are scoped to a specific dashboard panelId: number. Optional. Find annotations that are scoped to a specific panel userId: number. Optional. Find annotations created by a specific user type: string. Optional. alert|annotation Return alerts or user created annotations tags: string. Optional. Use this to filter global annotations. Global annotations are annotations from an annotation data source that are not connected specifically to a dashboard or panel. To do an “AND” filtering with multiple tags, specify the tags parameter multiple times e.g. tags=tag1&tags=tag2. Example Response: HTTP/1.1 200 Content-Type: application/json [ { "id": 1124, "alertId": 0, "dashboardId": 468, "panelId": 2, "userId": 1, "userName": "", "newState": "", "prevState": "", "time": 1507266395000, "timeEnd": 1507266395000, "text": "test", "metric": "", "type": "event", "tags": [ "tag1", "tag2" ], "data": {} }, { "id": 1123, "alertId": 0, "dashboardId": 468, "panelId": 2, "userId": 1, "userName": "", "newState": "", "prevState": "", "time": 1507265111000, "text": "test", "metric": "", "type": "event", "tags": [ "tag1", "tag2" ], "data": {} } ]
    Methods in io.nosqlbench.engine.clients.grafana with parameters of type GAnnotation
    Modifier and Type
    Method
    Description
    GAnnotation
    GrafanaClient.createAnnotation(GAnnotation gAnnotation)
    POST /api/annotations Example Request: POST /api/annotations HTTP/1.1 Accept: application/json Content-Type: application/json { "dashboardId":468, "panelId":1, "time":1507037197339, "timeEnd":1507180805056, "tags":["tag1","tag2"], "text":"Annotation Description" } Example Response: HTTP/1.1 200 Content-Type: application/json { "message":"Annotation added", "id": 1, }

  • Uses of GAnnotation in io.nosqlbench.engine.clients.grafana.analyzer

    Methods in io.nosqlbench.engine.clients.grafana.analyzer with parameters of type GAnnotation
    Modifier and Type
    Method
    Description
    GSnapshotInfo
    GrafanaRegionAnalyzer.createSnapshotForAnnotation(GAnnotation anno, GDashboard dashboard, String snid)