base 1 commit

Author: raghu0891

.github/CODEOWNERS

@@ -49,9 +49,6 @@ linters-settings:
           - (github.com/goplugin/plugin-common/pkg/logger.SugaredLogger).AssumptionViolationf
           - (github.com/goplugin/plugin-common/pkg/logger.SugaredLogger).Tracef
           - (github.com/goplugin/plugin-common/pkg/logger.SugaredLogger).Criticalf
-  errorlint:
-    # Allow formatting of errors without %w
-    errorf: false
   revive:
     confidence: 0.8
     rules:

.golangci.yml

@@ -1,3 +1,5 @@
-golang 1.21.4
+golang 1.22.7
+protoc 25.1
+protoc-gen-go-grpc 1.3.0
 golangci-lint 1.55.2
 mockery 2.43.2

.tool-versions

@@ -32,10 +32,10 @@ require (
 	github.com/riferrei/srclient v0.5.4
 	github.com/santhosh-tekuri/jsonschema/v5 v5.2.0
 	github.com/shopspring/decimal v1.4.0
-	github.com/goplugin/grpc-proxy v0.1.1 //plugin update changes
 	//github.com/goplugin/grpc-proxy v0.0.0-20240830132753-a7e17fec5ab7
-	github.com/goplugin/plugin-libocr v0.1.1-beta //plugin update changes
-	//github.com/goplugin/plugin-libocr v0.0.0-20240419185742-fd3cab206b2c
+	github.com/goplugin/grpc-proxy v0.1.1 //plugin update changes
+	//github.com/goplugin/plugin-libocr v0.0.0-20241007185508-adbe57025f12
+	github.com/goplugin/plugin-libocr v0.1.1 //plugin update changes
 	github.com/stretchr/testify v1.9.0
 	go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc v0.52.0
 	go.opentelemetry.io/otel v1.28.0

go.mod

@@ -223,8 +223,8 @@ github.com/sirupsen/logrus v1.9.3 h1:dueUQJ1C2q9oE3F7wvmSGAaVtTmUizReu6fjN8uqzbQ
 github.com/sirupsen/logrus v1.9.3/go.mod h1:naHLuLoDiP4jHNo9R0sCBMtWGeIprob74mVsIT4qYEQ=
 github.com/goplugin/grpc-proxy v0.0.0-20240830132753-a7e17fec5ab7 h1:12ijqMM9tvYVEm+nR826WsrNi6zCKpwBhuApq127wHs=
 github.com/goplugin/grpc-proxy v0.0.0-20240830132753-a7e17fec5ab7/go.mod h1:FX7/bVdoep147QQhsOPkYsPEXhGZjeYx6lBSaSXtZOA=
-github.com/goplugin/plugin-libocr v0.0.0-20240419185742-fd3cab206b2c h1:lIyMbTaF2H0Q71vkwZHX/Ew4KF2BxiKhqEXwF8rn+KI=
-github.com/goplugin/plugin-libocr v0.0.0-20240419185742-fd3cab206b2c/go.mod h1:fb1ZDVXACvu4frX3APHZaEBp0xi1DIm34DcA0CwTsZM=
+github.com/goplugin/plugin-libocr v0.0.0-20241007185508-adbe57025f12 h1:NzZGjaqez21I3DU7objl3xExTH4fxYvzTqar8DC6360=
+github.com/goplugin/plugin-libocr v0.0.0-20241007185508-adbe57025f12/go.mod h1:fb1ZDVXACvu4frX3APHZaEBp0xi1DIm34DcA0CwTsZM=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw=
 github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo=

go.sum

@@ -3,12 +3,13 @@ build:
 	go build -o observability-lib .
 
 .PHONY: run
-run:
-	go run main.go
+run: build
+	./observability-lib
 
 .PHONY: lint
 lint:
 	golangci-lint run
 
+.PHONY: test
 test:
 	go test -v ./...

observability-lib/Makefile

@@ -1,8 +1,135 @@
-## Observability-lib
+# Observability-lib
 
-Contains the observability library to build dashboards and alerts
+This library enables creating Grafana dashboards and alerts with go code.
+
+It provides abstractions to create grafana resources :
+- [Dashboards](https://grafana.com/docs/grafana/latest/dashboards/)
+- [Alerts](https://grafana.com/docs/grafana/latest/alerting/)
+- [Contact Points](https://grafana.com/docs/grafana/latest/alerting/fundamentals/notifications/contact-points/)
+- [Notification Policies](https://grafana.com/docs/grafana/latest/alerting/configure-notifications/create-notification-policy/)
+- [Notification Templates](https://grafana.com/docs/grafana/latest/alerting/configure-notifications/template-notifications/create-notification-templates/)
+
+## Folder Structure
+
+The observability-lib is structured as follows:
+```shell
+observability-lib/
+    api/ # Grafana HTTP API Client to interact with resources
+    cmd/ # CLI to interact deploy or generateJSON from dashboards defined in folder below
+    dashboards/ # Dashboards definitions
+    grafana/ # grafana-foundations-sdk abstraction to manipulate grafana resources
+```
+
+## Documentation
+
+Godoc generated documentation is available [here](https://pkg.go.dev/github.com/goplugin/plugin-common/observability-lib)
+
+## Quickstart
+
+### Creating a dashboard
+
+<details><summary>main.go</summary>
+
+```go
+package main
+
+import "github.com/goplugin/plugin-common/observability-lib/grafana"
+
+func main() {
+	builder := grafana.NewBuilder(&grafana.BuilderOptions{
+	    Name:       "Dashboard Name",
+	    Tags:       []string{"tags1", "tags2"},
+	    Refresh:    "30s",
+	    TimeFrom:   "now-30m",
+	    TimeTo:     "now",
+	})
+	
+	builder.AddVars(grafana.NewQueryVariable(&grafana.QueryVariableOptions{
+	    VariableOption: &grafana.VariableOption{
+	        Label: "Environment",
+	        Name:  "env",
+	    },
+	    Datasource: "Prometheus",
+	    Query:      `label_values(up, env)`,
+	}))
+	
+	builder.AddRow("Summary")
+	
+	builder.AddPanel(grafana.NewStatPanel(&grafana.StatPanelOptions{
+	    PanelOptions: &grafana.PanelOptions{
+	        Datasource:  "Prometheus",
+	        Title:       "Uptime",
+	        Description: "instance uptime",
+	        Span:        12,
+	        Height:      4,
+	        Decimals:    2,
+	        Unit:        "s",
+	        Query: []grafana.Query{
+	            {
+	                Expr:   `uptime_seconds`,
+	                Legend: `{{ pod }}`,
+	            },
+	        },
+	    },
+	    ColorMode:   common.BigValueColorModeNone,
+	    TextMode:    common.BigValueTextModeValueAndName,
+	    Orientation: common.VizOrientationHorizontal,
+	}))
+	
+	db, err := builder.Build()
+	if err != nil {
+	    return nil, err
+	}
+	json, err := db.GenerateJSON()
+	if err != nil {
+	    return nil, err
+	}
+	fmt.Println(string(json))
+}
+```
+</details>
+
+More advanced examples can be found in the [dashboards](./dashboards) folder :
+- [DON OCR](./dashboards/atlas-don/component.go)
+- [Capabilities](./dashboards/capabilities/component.go)
+- [Node General](./dashboards/core-node/component.go)
+- [Node Components](./dashboards/core-node-components/component.go)
+- [Kubernetes Resources](./dashboards/k8s-resources/component.go)
+- [NOP OCR Health](./dashboards/nop-ocr/component.go)
+
+## Cmd Usage
+
+The CLI can be used to :
+- Deploy dashboards and alerts to grafana
+- Generate JSON from dashboards defined in the `dashboards` folder
+
+`func NewDashboard(props *Props)` in each [dashboards](./dashboards) packages is called from [cmd](./cmd/builder.go) to deploy or generate JSON from the dashboard.
+
+Example to deploy a dashboard to grafana instance using URL and token:
+```shell
+make build
+./observability-lib deploy \
+  --dashboard-name DashboardName \
+  --dashboard-folder FolderName \
+  --grafana-url $GRAFANA_URL \
+  --grafana-token $GRAFANA_TOKEN \
+  --type core-node \
+  --platform kubernetes \
+  --metrics-datasource Prometheus
+```
+To see how to get a grafana token you can check this [page](https://grafana.com/docs/grafana/latest/administration/service-accounts/)
+
+Example to generate JSON from a dashboard defined in the `dashboards` folder:
+```shell
+make build
+./observability-lib generate \
+  --dashboard-name DashboardName \
+  --type core-node-components \
+  --platform kubernetes
+```
+
+## Makefile Usage
 
-## Usage
 
 To build the observability library, run the following command:
 

observability-lib/README.md

@@ -30,3 +30,24 @@ func (c *Client) PutNotificationTemplate(notificationTemplate alerting.Notificat
 
 	return grafanaResp, resp, nil
 }
+
+type DeleteNotificationTemplateResponse struct{}
+
+func (c *Client) DeleteNotificationTemplate(name string) (DeleteNotificationTemplateResponse, *resty.Response, error) {
+	var grafanaResp DeleteNotificationTemplateResponse
+
+	resp, err := c.resty.R().
+		SetResult(&grafanaResp).
+		Delete(fmt.Sprintf("/api/v1/provisioning/templates/%s", name))
+
+	if err != nil {
+		return DeleteNotificationTemplateResponse{}, resp, fmt.Errorf("error making API request: %w", err)
+	}
+
+	statusCode := resp.StatusCode()
+	if statusCode != 200 {
+		return DeleteNotificationTemplateResponse{}, resp, fmt.Errorf("error deleting notification template, received unexpected status code %d: %s", statusCode, resp.String())
+	}
+
+	return grafanaResp, resp, nil
+}

observability-lib/api/notification-template.go

@@ -53,6 +53,7 @@ func (c *Client) PostAlertRule(alertRule alerting.Rule) (PostAlertRuleResponse,
 
 	resp, err := c.resty.R().
 		SetHeader("Content-Type", "application/json").
+		SetHeader("X-Disable-Provenance", "true").
 		SetBody(alertRule).
 		SetResult(&grafanaResp).
 		Post("/api/v1/provisioning/alert-rules")