Recording Operations

​

Using Decorators for Instrumentation

​

@operation / @task Decorator

from agentops.sdk.decorators import operation

@operation
def process_data(data):
    # Process the data
    return result

@operation(name="custom-operation-name", version=1)
def process_data(data):
    # Process the data
    return result

from agentops.sdk.decorators import agent, operation

@agent
class MyAgent:
    @operation
    def perform_task(self, task):
        # Operation implementation
        return result

​

@workflow Decorator

from agentops.sdk.decorators import workflow

@workflow
def my_workflow(data):
    # Workflow implementation
    return result

​

@agent Decorator

from agentops.sdk.decorators import agent

@agent
class MyAgent:
    def __init__(self, name):
        self.name = name
        
    # Agent methods here

​

@session Decorator

from agentops.sdk.decorators import session

@session
def my_workflow():
    # Your session code here
    return result

​

Automatic Instrumentation

​

Best Practices

1. Use the Right Decorator: Choose the appropriate decorator based on what you’re instrumenting:
   • @session for the root of your application
   • @agent for agent classes
   • @operation for specific operations
   • @workflow for sequences of operations
2. Proper Nesting: Ensure that your spans are properly nested:
   • Session spans should be at the top
   • Agent spans should be children of session spans
   • Operation spans should be children of agent spans
3. Meaningful Names: Use meaningful names for your spans to make them easier to identify in the dashboard.
4. Record Important Data: The decorators automatically record function parameters and return values, but you can also add custom attributes to spans for additional context.