Tyke Python Agent

Tyke Python agent provides instrumentation for collecting traces data to be processed by Tyke.

This agent supports these frameworks and adds following capabilities:

• capture request and response headers
• capture request and response bodies
• capture SQL queries
• tracing context propagation

Tyke python agent supports Python 3.7+

Getting started

Instrumentation

Instrumentation requires editing your code to initialize an agent, and registering any applicable modules to be instrumented.

• Install the tyke python agent:

pip install tyke-agent

• Create a YAML file with the name config.yaml in the application root directory and add below content

service_name: "Service Name"
resource_attributes: 
    app.name: "Application Name"
    service.identifier: Service unique identifier

reporting:
    endpoint: http://localhost:4317
    token: <base64encodedtoken>  # Optional 

• Add the following to your app's entrypoint python file:

from tyke.agent import Agent


# Set config file location in environment variables 
os.environ.setdefault("TYKE_CONFIG_FILE", "config.yaml")

agent = Agent() # initialize the agent

# Instrument a flask app + any other applicable libraries
agent.instrument(app)

# Instrument a django app
agent.instrument()
...