Merge pull request #134 from netboxlabs/develop

release 🚚

Author: jajeffries

.github/golangci.yaml

@@ -1,40 +1,37 @@
+version: "2"
 run:
-  timeout: 5m
   modules-download-mode: readonly
-
-output:
-  formats: colored-line-number
-
 linters:
   enable:
-    - revive
-    - errcheck
-    - unused
-    - staticcheck
-    - ineffassign
-    - govet
-    - gosimple
     - bodyclose
+    - revive
+  exclusions:
+    generated: lax
+    rules:
+      - linters:
+          - revive
+        path: /*.go
+        text: 'package-comments: should have a package comment'
+    paths:
+      - third_party$
+      - builtin$
+      - examples$
+severity:
+  default: error
+formatters:
+  enable:
     - gci
     - gofumpt
-
-issues:
-  exclude-use-default: false
-  exclude-rules:
-    - path: /*.go
-      text: "package-comments: should have a package comment"
-      linters:
-        - revive
-
-severity:
-  default-severity: error
-
-linters-settings:
-  gci:
-    sections:
-      - standard
-      - default
-      - prefix(github.com/netboxlabs/orb-agent)
-    custom-order: true
-  go-fumpt:
-    extra-rules: true
+  settings:
+    gci:
+      sections:
+        - standard
+        - default
+        - prefix(github.com/netboxlabs/orb-agent)
+      custom-order: true
+  exclusions:
+    generated: lax
+    paths:
+      - third_party$
+      - builtin$
+      - examples$

.github/workflows/develop.yaml

@@ -12,7 +12,7 @@ permissions:
   contents: write
 
 env:
-  GO_VERSION: '1.23'
+  GO_VERSION: '1.24'
 
 jobs:
     build-and-push:

.github/workflows/lint.yaml

@@ -17,11 +17,11 @@ jobs:
       - name: Setup Go
         uses: actions/setup-go@v5
         with:
-          go-version: '1.23.x'
+          go-version: '1.24.x'
           check-latest: true
       - name: Lint
-        uses: golangci/golangci-lint-action@971e284b6050e8a5849b72094c50ab08da042db8 #v6.1.1
+        uses: golangci/golangci-lint-action@4afd733a84b1f43292c63897423277bb7f4313a9 #v8.0.0
         with:
-          version: v1.62
+          version: v2.1.6
           working-directory: .
           args: --config .github/golangci.yaml

.github/workflows/release.yaml

@@ -15,7 +15,7 @@ concurrency:
 env:
   GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
   SEMANTIC_RELEASE_PACKAGE: ${{ github.repository }}
-  GO_VERSION: '1.23'
+  GO_VERSION: '1.24'
   APP_NAME: orb-agent
 
 permissions:
@@ -65,7 +65,7 @@ jobs:
                     { "message": "*", "release": "patch"},
                     { "message": "fix*", "release": "patch" },
                     { "message": "feat*", "release": "minor" },
-                    { "message": "perf*",  "release": "major" }
+                    { "message": "major*",  "release": "major" }
                   ]
                 }],
                 "@semantic-release/release-notes-generator",
@@ -210,7 +210,7 @@ jobs:
                     { "message": "*", "release": "patch"},
                     { "message": "fix*", "release": "patch" },
                     { "message": "feat*", "release": "minor" },
-                    { "message": "perf*",  "release": "major" }
+                    { "message": "major*",  "release": "major" }
                   ]
                 }],
                 "@semantic-release/release-notes-generator",

.github/workflows/tests.yaml

@@ -34,7 +34,7 @@ jobs:
       - name: Setup Go
         uses: actions/setup-go@v5
         with:
-          go-version: '1.23.x'
+          go-version: '1.24.x'
           check-latest: true
       - name: Run go build
         run: go build ./...

.gitignore

@@ -1,3 +1,4 @@
+diode/
+orb-configs/
 build/
-.vscode/
-.coverage/
+.coverage/

Makefile

@@ -1,12 +1,10 @@
-include agent/docker/.env
-
-# expects to be set as env var
 PRODUCTION_AGENT_REF_TAG ?= latest
 PRODUCTION_AGENT_DEBUG_REF_TAG ?= latest-debug
 REF_TAG ?= develop
 DEBUG_REF_TAG ?= develop-debug
 PKTVISOR_TAG ?= develop
 PKTVISOR_DEBUG_TAG ?= develop-debug
+SNMP_DISCOVERY_TAG ?= latest
 DOCKERHUB_REPO = netboxlabs
 ORB_DOCKERHUB_REPO = netboxlabs
 BUILD_DIR = build
@@ -39,6 +37,9 @@ endif
 install-dev-tools:
 	@go install github.com/mfridman/tparse@latest
 
+.PHONY: deps
+deps:
+	@go mod tidy
 
 agent_bin:
 	echo "ORB_VERSION: $(ORB_VERSION)-$(COMMIT_HASH)"
@@ -63,6 +64,7 @@ agent:
 	docker build --no-cache \
 	  --build-arg GOARCH=$(GOARCH) \
 	  --build-arg PKTVISOR_TAG=$(PKTVISOR_TAG) \
+	  --build-arg SNMP_DISCOVERY_TAG=$(SNMP_DISCOVERY_TAG) \
 	  --tag=$(ORB_DOCKERHUB_REPO)/orb-agent:$(REF_TAG) \
 	  --tag=$(ORB_DOCKERHUB_REPO)/orb-agent:$(ORB_VERSION) \
 	  --tag=$(ORB_DOCKERHUB_REPO)/orb-agent:$(ORB_VERSION)-$(COMMIT_HASH) \
@@ -95,4 +97,4 @@ pull-latest-otel-collector-contrib:
 	cp ./agent/backend/otel/otelcol-contrib .
 	rm ./agent/backend/otel/otelcol_contrib.tar.gz
 	rm ./agent/backend/otel/LICENSE
-	rm ./agent/backend/otel/README.md
+	rm ./agent/backend/otel/README.md

README.md

@@ -60,10 +60,11 @@ orb:
     network_discovery:
     ...
 ```
-Only the `network_discovery`, `device_discovery` and `worker` backends are currently supported. They do not require any special configuration.
+Only the `network_discovery`, `device_discovery`, `worker` and `snmp_discovery` backends are currently supported. They do not require any special configuration.
 - [Device Discovery](./docs/backends/device_discovery.md) 
 - [Network Discovery](./docs/backends/network_discovery.md)
 - [Worker](./docs/backends/worker.md)
+- [SNMP Discovery](./docs/backends/snmp_discovery.md)
 
 #### Common
 A special `common` subsection under `backends` defines configuration settings that are shared with all backends. Currently, it supports passing [diode](https://github.com/netboxlabs/diode) server settings to all backends.
@@ -95,6 +96,9 @@ orb:
     worker:
       worker_policy_1:
        # see docs/backends/worker.md
+    snmp_discovery:
+      snmp_policy_1:
+       # see docs/backends/snmp.md
  ```
 
 ## Running the agent

agent/backend/cmd.go

@@ -81,10 +81,10 @@ func (c *CmdWrapper) Status() CmdStatus {
 
 // GetStdout returns the stdout channel
 func (c *CmdWrapper) GetStdout() <-chan string {
-	return c.Cmd.Stdout
+	return c.Stdout
 }
 
 // GetStderr returns the stderr channel
 func (c *CmdWrapper) GetStderr() <-chan string {
-	return c.Cmd.Stderr
+	return c.Stderr
 }

agent/backend/devicediscovery/device_discovery.go

@@ -43,6 +43,7 @@ type deviceDiscoveryBackend struct {
 	diodeClientID      string
 	diodeClientSecret  string
 	diodeAppNamePrefix string
+	diodeOtelEndpoint  string
 
 	startTime  time.Time
 	proc       backend.Commander
@@ -84,6 +85,12 @@ func (d *deviceDiscoveryBackend) Configure(logger *slog.Logger, repo policies.Po
 	d.diodeClientSecret = common.Diode.ClientSecret
 	d.diodeAppNamePrefix = common.Diode.AgentName
 
+	if common.Otel.Grpc != "" {
+		d.diodeOtelEndpoint = common.Otel.Grpc
+		d.logger.Info("device-discovery using OTLP metrics endpoint",
+			slog.String("endpoint", d.diodeOtelEndpoint))
+	}
+
 	return nil
 }
 
@@ -112,6 +119,10 @@ func (d *deviceDiscoveryBackend) Start(ctx context.Context, cancelFunc context.C
 		"--diode-app-name-prefix", d.diodeAppNamePrefix,
 	}
 
+	if d.diodeOtelEndpoint != "" {
+		pvOptions = append(pvOptions, "--otel-endpoint", d.diodeOtelEndpoint)
+	}
+
 	d.logger.Info("device-discovery startup", slog.Any("arguments", pvOptions))
 
 	pvOptions[9] = d.diodeClientSecret