Quickstart
Get NxtOne running in under five minutes with a single command and one config block.
This guide walks you through setting up NxtOne's runtime observation layer in a new or existing application. By the end, you'll have behavioral tracing active and shipping metadata directly to your NxtOne dashboard.
First Phase Support: During our initial release, we officially support Java 17+, Node.js (TS/JS) 18+, and Python 3.10+.
Choose Your Language Setup
1
Install the dependency or agent
Choose the command for your runtime environment:
Java (Spring Boot)
<dependency>
<groupId>io.nxtone</groupId>
<artifactId>nxtone-spring-boot-starter</artifactId>
<version>0.1.0</version>
</dependency>
Python (FastAPI / Flask)
Node.js (TypeScript / NestJS)
npm install @nxtone/agent-ts
2
Initialize the observation layer
Annotate or load the NxtOne agent in your code:
Java (Spring Boot)
Annotate your main application class with @NxtOneAgent:
import io.nxtone.annotation.NxtOneAgent;
@NxtOneAgent(sessionName = "payment-service")
@SpringBootApplication
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
}
Python (FastAPI / Flask)
Apply the @nxtone.NxtOneAgent decorator to your entry point:
import nxtone
@nxtone.NxtOneAgent(session_name="auth-service")
def main():
# your application startup here
pass
Node.js (TypeScript / NestJS)
Initialize NxtOne at the very top of your entry file (e.g., main.ts):
import * as nxtone from '@nxtone/agent-ts';
nxtone.init({
projectId: "api-gateway"
});
3
Set credentials and run
Configure the environment variables pointing to the NxtOne platform, then launch your app:
# Configure global settings
export NXTONE_API_KEY="nxt_live_abc123"
# Run your application as you normally would:
# Java
java -javaagent:nxtone-agent-0.1.0.jar -jar app.jar
# Python
python -m nxtone main.py
# Node.js
node dist/main.js
Success! You are done. Once your service starts, you will see a console message confirming the session connection (e.g., NXTONE_SESSION_ID=...) and the behavioral map will immediately begin populating in your dashboard interface.