Custom Instrumentation

Considerations

If you wish to create custom instrumentations for Go, Java, or PHP applications, you can define a “Custom Instrumentation” rule via the Odigos InstrumentationRule CRD or the Odigos UI. This feature is a great way to extend Odigos’s auto-instrumentation capabilities to cover your specific use cases and application logic. For Go and Java, custom instrumentation is applied dynamically via eBPF. For PHP, probes are delivered as environment variables and require a pod restart to take effect.

Configuration Options

Golang

When functionName is specified, receiverName and receiverMethodName must NOT be specified, and vice versa, if receiverName and receiverMethodName are specified, functionName must NOT be specified.packageName is required in all cases.

packageName

packageName string - The name of the package containing the function to instrument.

This field is required

functionName

functionName string - The name of the function to instrument.

This field is optional

receiverName

receiverName string - The name of the receiver type if the function is a method.

This field is optional

receiverMethodName

receiverMethodName string - The name of the method receiver if the function is a method.

This field is optional

Java

className

className string - The fully qualified name of the class containing the method to instrument.

This field is required

methodName

methodName string - The name of the method to instrument.

This field is required

PHP

className

className string - The fully qualified class name to instrument. Leave empty for a global function.

This field is optional

functionName

functionName string - The name of the function or method to instrument.

This field is required

Basic Example

The following example shows how to create a “Custom Instrumentation” rule that instruments a function named ProcessOrder in the github.com/example/ecommerce package.

Create a YAML file named custom-instrumentation.yaml with the following content:

Package and function (Golang)

apiVersion: odigos.io/v1alpha1
kind: InstrumentationRule
metadata:
    name: custom-instrumentation-rule
    namespace: odigos-system
spec:
    ruleName: "Custom Instrumentation for ProcessOrder"
    customInstrumentations:
        golang:
          - packageName: "github.com/example/ecommerce"
            functionName: "ProcessOrder"

Receiver method (Golang)

apiVersion: odigos.io/v1alpha1
kind: InstrumentationRule
metadata:
    name: custom-instrumentation-rule
    namespace: odigos-system
spec:
    ruleName: "Custom Instrumentation for ProcessOrder Method"
    customInstrumentations:
        golang:
          - packageName: "github.com/example/ecommerce"
            receiverName: "OrderProcessor"
            receiverMethodName: "ProcessOrder"

Class and method (Java)

apiVersion: odigos.io/v1alpha1
kind: InstrumentationRule
metadata:
    name: custom-instrumentation-rule
    namespace: odigos-system
spec:
    ruleName: "Custom Instrumentation for getCurrencyInfo"
    customInstrumentations:
        java:
          - className: "com.example.CurrencyService"
            methodName: "getCurrencyInfo"

Class and function (PHP)

apiVersion: odigos.io/v1alpha1
kind: InstrumentationRule
metadata:
    name: custom-instrumentation-rule
    namespace: odigos-system
spec:
    ruleName: "Custom Instrumentation for processOrder"
    customInstrumentations:
        php:
          - className: "App\\Service\\OrderService"
            functionName: "processOrder"

Apply the action to the cluster:

kubectl apply -f custom-instrumentation.yaml

Getting Started

Odigos AI

Instrumentations

Odigos Pipeline

Destinations

Concepts

Authentication

Contribution Guidelines

Custom Instrumentation

Considerations

Configuration Options

Basic Example

​Considerations

​Configuration Options

​Basic Example

Considerations

Configuration Options

Basic Example