OverOps Influx Backend

This project goal is to enable Grafana to visualize OverOps (www.overops.com) events data and time-series metrics.

Table of Contents

Background
     Influx Samples
OverOps Influx Backend Project
     Functions
         Regression Report
         Deployments
Setup
Support
License

Background

Influx REST API gets a query similar to SQL and respond with a list of series.
Each series have multiple values attach to a timestamp.

Influx Samples

Input:

curl -G 'http://localhost:8086/query?pretty=true' 
  --data-urlencode "db=mydb" 
  --data-urlencode "q=SELECT \"value\" 
                      FROM \"cpu_load_short\" 
                      WHERE \"region\"='us-west'"

Output:

{
    "results": [ { "statement_id": 0,
            "series": [ {
                    "name": "cpu_load_short",
                    "columns": [ "time", "value" ],
                    "values": [ [
                            "2015-01-29T21:55:43.702900257Z", 2
]]}]}]}

OverOps Influx Backend Project

In order to utilize the power of Grafana+Influx, this project introduces, and parses a new query language.

It heavily utilizes the OverOps API Client and REST APIs.

The solution has two components:

1. A Java REST endpoint that works as an Influx /query API.
2. A set of dashboards that uses a special query language in order to fetch OverOps related metrics. The dashboards json files are located in this folder.

The project is bundled as part of the OverOps API Server, and can be run separately as a spring-boot uber jar.

Functions

Regression Report

This function returns a report for a a target set of applications, deployments or tiers (i.e. categories) listing an possible new errors, increases (i.e. regressions) and slowdowns.

Source Code

Template:

regressionReport({"timeFilter":"$timeFilter","
  environments":"$environments",
  "applications":"$applications",
  "servers":"$servers",
  "deployments":"$deployments",
  "view":"$view",
  "pointsWanted":"$pointsWanted",
  "transactionPointsWanted":"$transactionPointsWanted"
  "types":"$type",
  "render":"Grid",
  "mode":"Tiers",
  "limit":"$limit",
  "sevAndNonSevFormat":"%d (%d p1)",
  "sevOnlyFormat":"%d p1"})

Live:

curl -G 'http://localhost:8086/query?pretty=true' 
  --data-urlencode "db=mydb" 
  --data-urlencode "q=regressionReport({
    "timeFilter":"time >= now() - 7d",
    "environments":"(Prod: S1234)",
    "applications":"all",
    "servers":"all",
    "deployments":"all",
    "view":"All Events",
    "pointsWanted":"24", "transactionPointsWanted":"100",
    "types":"all",
    "render":"Grid",
    "mode":"Deployments",
    "limit":"10",
    "sevAndNonSevFormat":"%d (%d p1)",
    "sevOnlyFormat":"%d p1"})

Output:

{
	"results": [{
		"statement_id": 0,
		"series": [{
			"name": "events",
			"columns": ["from", "to", "timeRange", "Service", "Key", "Name", "NewIssues", "Regressions", "Slowdowns", "NewIssuesDesc", "RegressionsDesc", "SlowdownsDesc", "Score", "ScoreDesc"],
			"values": [
				["now-7d", "now", "7d", "S1234", "v4.0.2113", "v4.0.2113", 10, "2 p1", "3  (2 p1)", "SocketTimeoutException in CryptoProto$PEncryptedData, ClientAbortException in ParallaxTimerProto$PParallaxTimerData, Logged Warning in RestApiTokenUtil\nand 7 more", "+39% Logged Error in JarClassBytesRetriever$ZeusonV1Retriever, +87% Logged Warning in BackendSourceCodeProcessor", "+289% GracefulTask, +280% QueueMessagesDaemon, +234% FunctionParser$FunctionAsyncTask", 52.5, "100 - (10 new issues + 2 severe error increases * 2 + 1 slowdown + 2 severe slowdowns * 2) * 2.5, avg over 1 days \u003d 52.5. Weights are defined in the Settings dashboard.", "v4.0.2113 over . 1 day agoNew errors: SocketTimeoutException in CryptoProto$PEncryptedData, ClientAbortException in ParallaxTimerProto$PParallaxTimerData, Logged Warning in RestApiTokenUtil\nand 7 moreIncreasing Errors: +39% Logged Error in JarClassBytesRetriever$ZeusonV1Retriever, +87% Logged Warning in BackendSourceCodeProcessorSlowdowns: +289% GracefulTask, +280% QueueMessagesDaemon, +234% FunctionParser$FunctionAsyncTask"],
			]
		}]
	}]
}

Deployments

This function returns the list of active deployments within the target environments

Source Code

Template:

deployments({"environments":"$environments","sorted":"true"})

Live:

curl -G 'http://localhost:8086/query?pretty=true' 
  --data-urlencode "db=mydb" 
  --data-urlencode "q=deployments({  
    "environments":"Prod: S1234",  
    "sorted":"true"})

Output:

{
	"results": [{
		"statement_id": 0,
		"series": [{
			"name": "events",
			"columns": ["key", "value"],
			"values": [
				["key", "v4.0.2118"],
				["key", "v4.0.2115"]
			]
		}]
	}]
}

Setup

Follow grafana/README.md for more deployment options and setup instructions.

Support

If you need support, contact us at [email protected].

License

Copyright (c) OverOps Inc. All rights reserved.

Licensed under the MIT License.