Do language-specific steps
Configure other agents to send telemetry to Splunk Observability Cloud.
Use this workflow for applications that don't run on Kubernetes.
- Java
-
Secure Application integrates runtime security detection into your Java application through a JVM extension (
splunk-otel-javaagent-csa) that works with the Splunk Distribution of OpenTelemetry Java.If your application already uses the standard Splunk OpenTelemetry Java agent, replace that JAR with the Secure Application JVM extension JAR. The Secure Application JVM extension handles both Splunk APM instrumentation and Secure Application library scanning.
-
Download the Secure Application JVM extension version 2.25.1 or higher JAR file:
SHELLcurl -L https://repo1.maven.org/maven2/com/splunk/splunk-otel-javaagent-csa/<version>/splunk-otel-javaagent-csa-<version>.jar -o splunk-otel-javaagent-csa.jarNote: The name you give to the downloaded JAR file must containsplunk-otel-javaagent. -
Restart your application with the Secure Application JVM extension and its required configuration parameters. You can set these values through system properties or environment variables.
BASHjava -javaagent:./splunk-otel-javaagent-csa.jar \ -Dotel.service.name=<service-name> \ -Dotel.resource.attributes=deployment.environment.name=<environment-name>,service.namespace=<namespace-name> \ -Dotel.exporter.otlp.endpoint=http://<collector-endpoint>:4318 \ -Dargento.allow.security.events=true \ -jar <application-name>.jarSyntax:
BASHjava -javaagent:./splunk-otel-javaagent-csa.jar \ -Dotel.service.name=<service-name> \ -Dotel.resource.attributes=deployment.environment.name=<environment-name>,service.namespace=<namespace-name> \ -Dotel.exporter.otlp.endpoint=http://<collector-endpoint>:<collector-port> \ -Dargento.allow.security.events=true \ -jar <application-name>.jarTable 1. Secure Application JVM extension parameters System property Environment variable Description argento.allow.security.eventsNone Add this flag when you want Secure Application to collect attack events. You must include this flag to populate the Attacks page. otel.exporter.otlp.endpointOTEL_EXPORTER_OTLP_ENDPOINTOTLP endpoint for your OpenTelemetry Collector. Use port 4318for OTLP/HTTP or port4317for OTLP/gRPC, depending on your collector configuration.Example:
http://otel-collector:4318otel.resource.attributesOTEL_RESOURCE_ATTRIBUTESResource attributes to associate with your Java application.
Recommended:
deployment.environment.nameservice.namespace. For information about this parameter, see Service Attributes. For help with the JVM agent, see Instrument Java applications for Splunk Observability Cloud.
If you set
otel.service.nameorOTEL_SERVICE_NAME, don't also defineservice.nameinotel.resource.attributes.otel.service.nameOTEL_SERVICE_NAMEService name of your Java application. This value sets the service.nameresource attribute. -
Verify Secure Application instrumentation:
-
Confirm that the application starts with
splunk-otel-javaagent-csa.jar. -
Confirm that your OpenTelemetry Collector receives telemetry from the application and doesn't report export errors for Secure Application data.
-
-
Look for security events in after a few minutes.
Runtime library and vulnerability data appear on the corresponding tabs. Attack events appear on the Attacks tab only if you start the application with
-Dargento.allow.security.events=true.
Tip:To roll back JVM extension changes, replace
splunk-otel-javaagent-csa.jarwith your previous Java agent JAR, remove-Dargento.allow.security.events=trueif you added it, and restart the application. - Node.js
-
-
Instrument your application with Splunk OpenTelemetry JS version 4.x.
-
Activate Secure Application instrumentation for the Node.js agent.
Set the
SPLUNK_SECUREAPP_AGENT_ENABLEDenvironment variable totrue.CODEexport SPLUNK_SECUREAPP_AGENT_ENABLED=true -
Configure the OTLP logs endpoint.
By default, the Node.js agent sends Secure Application logs to
http://localhost:4318/v1/logsbut you can change this by setting one of these environment variables:Environment variable Description Example OTEL_EXPORTER_OTLP_ENDPOINTBase OTLP endpoint. The Node.js agent appends
/v1/logswhen it sends Secure Application logs.http://localhost:4318OTEL_EXPORTER_OTLP_LOGS_ENDPOINTFull OTLP logs endpoint. The Node.js agent doesn't append
/v1/logs.https://localhost:4318/v1/logs -
Set service metadata for your Node.js application.
Environment variable Description Example OTEL_SERVICE_NAMEService name for the instrumented Node.js application.
checkout-serviceOTEL_RESOURCE_ATTRIBUTESResource attributes that describe the instrumented service.
deployment.environment=test -
Optional: Configure Secure Application runtime reporting.
Environment variable Description Default SPLUNK_SECUREAPP_DEPENDENCY_SCAN_INTERVALTime, in milliseconds, between dependency scans.
86400000(24 hours)SPLUNK_SECUREAPP_RUNTIME_PACKAGES_ONLYWhen set to
true, reports only packages loaded at runtime.trueSPLUNK_SECUREAPP_NO_SELF_REPORTWhen set to
true, excludes dependencies of the Node.js agent from the report.false -
Run your Node.js application:
SHELLnode -r @splunk/otel/instrument <your-application>.js
Your Node.js application launches with Secure Application instrumentation activated. The Node.js agent does the following:
-
Sends vulnerability and library data to the Splunk Observability Cloud back end.
-
Collects potential attack events at runtime.
-
Reports data once at application startup and then every 24 hours thereafter.
- Python
-
Secure Application integrates runtime security detection into your Python application through a Python extension (
secureapp-python-agent) that works with the Splunk Distribution of OpenTelemetry Python. This extension sends the OpenTelemetry events and logs that Secure Application needs to Splunk Observability Cloud. Follow these steps to add this extension to your Python application.Note: The examples in this topic are for a Linux environment.-
Confirm that you meet the Python instrumentation requirements.
-
Install the Secure Application Python extension (
secureapp-python-agent):-
If you've already installed the Splunk Distribution of OpenTelemetry Python, you already have the Splunk instrumentation agent (
splunk-opentelemetry) installed. Just install the Secure Application Python extension:BASHpip install secureapp-python-agent -
Otherwise, install the Secure Application Python extension together with the Splunk instrumentation agent (
splunk-opentelemetry):BASHpip install "splunk-opentelemetry[secureapp]"
Tip: If you're using a requirements.txt or pyproject.toml file, addsplunk-opentelemetryto it. -
-
(Optional) Set these environment variables to customize the behavior of the Secure Application Python extension. However, using the default values is strongly recommended:
Environment variable Default Description SPLUNK_SECUREAPP_AGENT_ENABLEDtrueActivate or deactivate the agent. SPLUNK_SECUREAPP_DEPENDENCY_INITIAL_DELAY60.0Initial delay (seconds) before dependency tracking starts. SPLUNK_SECUREAPP_DEPENDENCY_SCAN_INTERVAL86400Interval (seconds) between dependency scans (24 hours). Example:
BASHexport SPLUNK_SECUREAPP_AGENT_ENABLED=true export SPLUNK_SECUREAPP_DEPENDENCY_INITIAL_DELAY=60 export SPLUNK_SECUREAPP_DEPENDENCY_SCAN_INTERVAL=86400 -
(Optional) If you haven't already done so, run the
opentelemetry-bootstraptool to scan your current Python environment, detect which libraries you have installed, and automatically install the necessary OpenTelemetry instrumentation packages for them:BASHopentelemetry-bootstrap -a installAlternatively, run the
opentelemetry-bootstraptool to print the supported packages to the console, and add the output to your requirements.txt or pipfile:CODEopentelemetry-bootstrap -
Run your Python application with the
opentelemetry-instrumentwrapper.BASHopentelemetry-instrument python3 <application-name>.py -
(Optional) Send data directly to Splunk Observability Cloud.
By default, the extension sends all telemetry to the local instance of the Splunk Distribution of OpenTelemetry Collector. To send data directly to Splunk Observability Cloud, set the
SPLUNK_ACCESS_TOKENandSPLUNK_REALMenvironment variables:BASHexport SPLUNK_ACCESS_TOKEN=<access-token> export SPLUNK_REALM=<realm>To obtain a Splunk access token, see Retrieve and manage user API access tokens using Splunk Observability Cloud. To find your Splunk realm, see Configure SSO integrations for Splunk Observability Cloud. For more information on the ingest API endpoints, see Send APM traces.
-
Set service metadata for your Python application.
For descriptions of these environment variables, see Configure the Python agent for Splunk Observability Cloud:
OTEL_SERVICE_NAMEOTEL_RESOURCE_ATTRIBUTES
Sample minimal configuration for a Kubernetes environment:
BASHexport OTEL_SERVICE_NAME=<application-name> export OTEL_RESOURCE_ATTRIBUTES="service.name=<application-name>,service.version=<version>" -
Look for security events in after a few minutes.
Your Python application:
-
Sends vulnerability and library data to the Splunk Observability Cloud backend.
-
Collects potential attack events at runtime.
-
Reports data once at application startup and then every 24 hours thereafter.
-
- .NET
-
The .NET combined agent supports Splunk AppDynamics and Splunk Observability Cloud APM in one deployment. If your organization uses the AppDynamics .NET Agent version 26.9 in dual mode, you can use Secure Application runtime vulnerability detection without installing a separate Secure Application agent or adding a second profiler.
Secure Application vulnerability telemetry uses one selected security signal path at a time:
- Use the Splunk AppDynamics signal path to send runtime vulnerability findings to Secure Application in Splunk AppDynamics.
- Use the Splunk OpenTelemetry signal path to send runtime vulnerability findings to Secure Application in Splunk Observability Cloud.
Selecting a security signal path doesn't change the existing APM telemetry behavior of the combined-agent deployment.
-
Confirm the following support boundaries before you configure Secure Application for .NET services:
Component Requirement .NET runtime Use .NET 8, .NET 9, or .NET 10. .NET Framework isn't supported for Secure Application runtime vulnerability detection. Operating system and architecture For Linux, use x64 or ARM64 with glibc or musl on RHEL 8 or higher, CentOS 9 or higher, Ubuntu 22.04 or higher, Debian 12 or higher, or Alpine 3.21 or higher. For Windows, use x64 or x86. Deployment model Use one supported .NET combined-agent installation in dual mode. Don't deploy a second Secure Application agent, a second profiler, or a duplicate instrumentation path. Agent version Use AppDynamics .NET Agent version 26.9. Security signal path Select either the Splunk AppDynamics signal path or the Splunk OpenTelemetry signal path for runtime vulnerability telemetry. Simultaneous vulnerability delivery through both security signal paths isn't supported. Realm availability Secure Application supports this capability in active AWS realms where Secure Application is available. GCP realms aren't supported. Detection scope This release covers runtime vulnerability detection and library context for loaded third-party libraries. Runtime attack detection, attack notifications, attack blocking, and runtime application self-protection (RASP) policies aren't supported for .NET in this release. Dependency inspection The agent sends package name and version dependency reports when the application node starts or restarts, and then once every 24 hours while active. Secure Application evaluates only the dependencies included in each report. The agent doesn't use an event-driven hook to report every assembly loaded after startup. A NuGet package or assembly loaded dynamically after startup is normally detected on the next dependency report, up to about 24 hours later, unless the agent triggers another report. Unsupported deployment types Single-file deployments and ahead-of-time (AOT) compilation aren't supported. -
Configure the security signal path
Before you configure Secure Application vulnerability telemetry, configure the .NET combined agent for dual-signal operation. See Enable OpenTelemetry in the .NET agent.
Configure the .NET combined agent to send Secure Application vulnerability telemetry through the signal path that matches your migration plan. Use the Splunk AppDynamics signal path when you want findings in Secure Application in Splunk AppDynamics. Use the Splunk OpenTelemetry signal path when you want findings in Secure Application in Splunk Observability Cloud.
Use only one security signal path for vulnerability telemetry. The selected path must not create duplicate services, spans, libraries, or vulnerability findings.
-
View findings in Splunk Observability Cloud
When you select the Splunk OpenTelemetry signal path, runtime vulnerability findings appear in the existing Secure Application experience in Splunk Observability Cloud.
- Log in to Splunk Observability Cloud.
- Select APM.
- Under Application Security, select Runtime vulnerabilities.
- Select Language > .Net, or select a specific service.
- Select a vulnerability to view library, CVE, severity, affected service, environment, and remediation information.
-
Validate the setup
After you configure the security signal path, verify that the selected destination receives Secure Application data for the .NET service:
- Runtime vulnerability findings appear in the selected destination.
- Findings include the available library name, library version, CVE, severity, affected service, environment, and remediation information.
- The deployment doesn't create duplicate services, spans, libraries, or vulnerability findings.
- Existing .NET APM behavior remains operational.