Setup guides: every way to connect an app
Pick the path that fits where the app runs. Every path needs a project API key. Create one in Settings → API keys, or use Setup → Connect an app (/setup) for a guided setup with a live check. Each path reads the key from SHIELD360_API_KEY or a secret.
In the app, Setup → Other ways to connect (/setup?tab=guides) lists the same guides with your Shield360 address already in every snippet.
By stage
Section titled “By stage”| Stage | Start with |
|---|---|
| Local development | shield360 run, shield360 init |
| CI | GitHub Actions or GitLab CI, or shield360 run around the test command |
| Staging and production | Kubernetes operator and Helm, an SDK, plain OpenTelemetry or serverless |
No code change
Section titled “No code change”| Guide | What it does |
|---|---|
shield360 run | Starts any Node, Python or Java app with Shield360: shield360 run -- npm start |
shield360 init | Reads the repository (language, Dockerfiles, Compose, Kubernetes manifests) and sets it up. It never writes the key |
| Zero-code setup | What the preload traces in each runtime |
Shield360 SDKs
Section titled “Shield360 SDKs”| Language | Guide |
|---|---|
| Node.js | Zero-code setup: npm install shield360, then node --require shield360/register app.js |
| Python | SDK overview |
| .NET | .NET overview |
| Go | Go overview |
Only the Node.js SDK is in its public registry today. For the others, use shield360 run (Python, Java) or plain OpenTelemetry until their packages are published.
Kubernetes
Section titled “Kubernetes”Kubernetes operator: one helm install with injectNamespaces.<namespace>=<language> opts whole namespaces in, and the operator adds the SDK to every new pod with no image change. The API key is read from a Secret in each namespace. The chart never takes the key itself.
Any OpenTelemetry language
Section titled “Any OpenTelemetry language”OpenTelemetry in any language: Java, Ruby, PHP, Rust, Elixir, C++, or any app that exports OTLP (directly or through a Collector). Set the standard OTEL_EXPORTER_OTLP_* variables to your Shield360 address and key.
Serverless
Section titled “Serverless”| Platform | Guide |
|---|---|
| AWS Lambda | AWS Lambda |
| Vercel | Vercel |
| Cloudflare Workers | Cloudflare Workers |
CI pipelines
Section titled “CI pipelines”CI pipelines: the Shield360 GitHub Action, or a GitLab CI template, to record deploy markers (shield360 ci release), send JUnit test results (shield360 ci tests) and run a code security scan.