reference
57 pages@nais/apm API reference
Every export, signature, and option of the @nais/apm browser SDK — init, captureException, captureMessage, setUser, setContext, captureFeedback, and more.
Access policy reference
The following hosts are by default accessible for every workload: You do not need to specify these hosts in your access policies.
Auth reference
In some cases, you want to locally develop and test against a secured API in the development environments. You will need a token to access said API.
Auto-configuration reference
Auto-generated frontend configuration values, environment variables, and the nais.js file structure.
Buckets reference
There is no automatic backup enabled for buckets. I.e. the files can not be restored in the event of accidental deletion or storage system failure.
CDN Upload Action
This is the reference documentation for the CDN Upload GitHub action. The action accepts the following inputs:
Config reference
This is the reference documentation for configs on the Nais platform. Visit Nais Console <span class="emoji-icon"><svg xmlns="http://www.w3.org/2000/svg" width="16px" height="16px" viewBox="0 0 16…
Container security
The following settings are applied to all containers running in Nais: To override these settings, see the following how-to guides:
Default workload variables
These environment variables will be injected into your workload container
Deploy with the Nais CLI
Deploys to Nais are done with the Nais CLI's nais apply command. In GitHub Actions, use the nais/setup action to install the CLI.
DQL Reference
Dashboards Query Language (DQL) Reference for filtering data in nav-logs (OpenSearch Dashboards).
Entra ID reference
For all possible configuration options, see the 📚 Nais application reference. Your application will automatically be injected with the following environment variables at runtime.
Environment variables for Kafka
These variables are made available to your application when Kafka is enabled. Aiven has written several articles on how to configure your application. We use SSL, so ignore the SASL-SSL examples:
Environments
This is a overview over the different environments and their available domains. Environments are sometimes also called clusters.
Frontend observability troubleshooting
Common issues and solutions for frontend observability with Faro.
Global Metrics
This is a list of metrics exposed by nais for all applications. The following labels are common to most metrics:
Grafana Glossary
This glossary contains terms and concepts related to Grafana. A dashboard is a collection of panels arranged in a grid layout. Each panel is a single visualization or a single query result. You can…
ID-porten reference
For all possible configuration options, see the 📚 Nais application reference. Your application will automatically be injected with the following environment variables at runtime.
Ingress reference
This is the reference documentation for ingresses in Nais. Ingress is the only way to expose your application to the outside world, this is not the recommended way to communicate between applications…
Issues and fingerprinting
How Nais APM groups errors into issues — versioned fingerprints, the tiers that decide grouping, and what makes two errors "the same issue".
Kafka Pools
This is a list of available Kafka pools for topics and applications. Topic resources can only be specified in GCP clusters. Applications can access topics from any cluster, including on-premises.
Label reference
Labels are user-defined key-value pairs used to organize and categorize your resources. See the labels explanation for background.
Log Destinations
Available log destinations for application logging in Nais.
LogQL Reference
LogQL reference documentation for querying logs in Grafana Loki.
Loki Labels Reference
Loki label reference documentation for querying logs in Grafana Loki.
Maskinporten reference
See the 📚 Nais application reference. Your application will automatically be injected with environment variables at runtime.
Metrics reference
The default metrics retention is 30 days. If you need data stored longer than this, we recommend using BigQuery. Then you have full control of the database and retention.
Nais Application example YAML
This is a complete example of an Application resource, commonly known as the nais.yaml file. For an in-depth explanation of each field, head over to the reference documentation.
Nais Application reference
This document describes all possible configuration values in the Application spec, commonly known as the nais.yaml file.
Nais Job example YAML
This is a complete example of an Naisjob resource. For an in-depth explanation of each field, head over to the reference documentation.
Nais Job reference
This document describes all possible configuration values in the Naisjob spec. By default, no traffic is allowed between naisjobs inside the cluster. Configure access policies to explicitly allow…
Nais OpenSearch example YAML
This is a complete example of a OpenSearch resource. For an in-depth explanation of each field, head over to the reference documentation.
Nais OpenSearch reference
This document describes all possible configuration values in the OpenSearch spec. Http controls HTTP settings for the OpenSearch instance.
Nais Postgres example YAML
This is a complete example of a Postgres resource, commonly known as the postgres.yaml file. For an in-depth explanation of each field, head over to the reference documentation.
Nais Postgres reference
This document describes all possible configuration values in the Postgres spec, commonly known as the postgres.yaml file.
Nais Topic example YAML
This is a complete example of an Topic resource, commonly known as the topic.yaml file. For an in-depth explanation of each field, head over to the reference documentation.
Nais Topic reference
This document describes all possible configuration values in the Topic spec, commonly known as the topic.yaml file.
Nais Valkey example YAML
This is a complete example of a Valkey resource. For an in-depth explanation of each field, head over to the reference documentation.
Nais Valkey reference
This document describes all possible configuration values in the Valkey spec. Databases defines the number of logical databases for the Valkey instance. The default is 16.
Observability Glossary
Observability is the art of understanding how a system behaves by adding instrumentation such as logs, metrics, and traces.
OpenSearch reference
The spec.openSearch configuration allows you to reference a single OpenSearch instance with a desired access mode.
OpenTelemetry Auto-Instrumentation Configuration
When you enable auto-instrumentation in your application the following OpenTelemetry configuration will become available to your application as environment variables:
OpenTelemetry Metrics
This is a list of metrics exported by the OpenTelemetry SDKs and auto-instrumentation libraries. The OpenTelemetry SDKs and auto-instrumentation libraries export the following general metrics:
OpenTelemetry Trace Semantic Conventions
OpenTelemetry Semantic Conventions define a common set of attribute names for spans, so that traces from different languages and libraries can be queried and correlated consistently. This page lists…
Postgres reference
The full configuration options for the Postgres instance can be found in the Postgres resource reference.
Postgres reference
The full configuration options for the Postgres instance can be found in the application spec reference.
Prometheus Alerting Rule Reference
PrometheusRule resource specification for defining alerts in Prometheus.
PromQL Reference
PromQL reference documentation for querying metrics in Prometheus.
Secrets reference
This is the reference documentation for secrets on the Nais platform. Visit Nais Console to find and manage your team's user-defined secrets.
Span Metrics
Span metrics are collected for each span and provide insight into the performance of your application. On our platform, these metrics are generated by the Grafana Tempo metrics generator and exported…
TokenX reference
See the 📚 Nais application reference. Your application will automatically be injected with environment variables at runtime.
TraceQL Reference
TraceQL reference documentation for querying traces in Grafana Tempo.
URL and deep-link contract
The stable URL and query-parameter contract for deep-linking into Nais APM from alerts, runbooks, and shared investigations.
Validation and autocompletion in editors
We expose two JSON schemas intended for use with editors to help the developer experience. These can be used for validation, autocompletion and documentation in supported editors.
Valkey reference
The spec.valkey field takes a list of records of two fields, instance and access: For details, see the manifest reference for your workload type:
Vulnerability reference
Due to Trivy, you'll receive a simplified dependency graph, as Trivy doesn't support Gradle or Maven's dependency resolution.
Webproxy
In Navs on-premises environments, workloads that need to make external HTTP(S) requests must set webproxy to true in their application spec.