tyke-agent 0.1.7

Tyke Python Agent

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.6+

Library	Description	Supported Library Versions
flask	A micro web framework written in Python.	1.*, 2.*
django	Python web framework	1.10+
grpc	Python GRPC library.	1.27+
mysql-connector	Python MySQL database client library.	8.*
psycopg2/psycopg2-binary/postgresql	Python Postgresql database client library.	2.7.3.1+
requests	Python HTTP client library.	2.*
aiohttp	Python async HTTP client library.	3.*
pymongo	Python mongodb pymongo library.	>= 3.1+, < 5.0

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

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

from tyke.agent import Agent

agent = Agent() # initialize the agent

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

# Instrument a flask app, additional libraries, except for mysql
# the second argument tells the agent to skip these specific libraries from being instrumented
agent.instrument(app, ['mysql'])


# if you aren't using flask, you can pass None
# and still provide skip libraries if needed
agent.instrument(None, ['flask', 'mysql'])

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