Instana

https://www.ibm.com/docs/en/instana-observability
Admin
Instana is an observability platform that provides automated application performance monitoring,...
Tokens:2,008,761
Snippets:15,990
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Example 3: Start services

Source: https://www.ibm.com/docs/en/instana-observability/saas?topic=suntd-setting-up-net-tracing-docker-instana-base-images

Command to start the services defined in the docker-compose.yml file.

```bash
docker-compose up -d
```

--------------------------------

### Start the agent

Source: https://www.ibm.com/docs/en/instana-observability/saas?topic=agents-installing-zos-unix-system-services-uss

Start the agent manually after completing the previous setup steps.

```bash
INSTANA_AGENT_FOLDER/bin/start
```

--------------------------------

### Install Python Packages for Single-Collection Example

Source: https://www.ibm.com/docs/en/instana-observability/saas?topic=databases-milvus

Installs the required Python packages for the basic single-collection example: pymilvus, traceloop-sdk, ibm-watsonx-ai, and langchain-ibm.

```bash
pip install pymilvus traceloop-sdk ibm-watsonx-ai langchain-ibm
```

--------------------------------

### Install Minikube and Start Kubernetes Cluster

Source: https://www.ibm.com/docs/en/instana-observability/saas?topic=kubernetes-installing-agent

Install Minikube and kubectl on CentOS, then start a Kubernetes cluster using Docker. These steps are an example to show the target environment.

```bash
cat <<EOF | sudo tee /etc/yum.repos.d/kubernetes.repo
[kubernetes]
name=Kubernetes
baseurl=https://pkgs.k8s.io/core:/stable:/v1.28/rpm/
enabled=1
gpgcheck=1
gpgkey=https://pkgs.k8s.io/core:/stable:/v1.28/rpm/repodata/repomd.xml.key
exclude=kubelet kubeadm kubectl cri-tools kubernetes-cni
EOF
```

```bash
sudo yum install -y kubectl
```

```bash
curl -LO https://storage.googleapis.com/minikube/releases/latest/minikube-latest.x86_64.rpm
```

```bash
sudo rpm -Uvh minikube-latest.x86_64.rpm
```

```bash
minikube start --force --driver=docker
```

```bash
eval $(minikube docker-env)
```

```bash
kubectl cluster-info
```

--------------------------------

### Setup example with and without options

Source: https://www.ibm.com/docs/en/instana-observability/saas?topic=applications-flutter-monitoring-api

Shows how to initialize Instana in initState() with a key and reporting URL, and optionally pass SetupOptions to disable collection. The commented alternative demonstrates passing options.

```dart
@override
void initState() {
  super.initState();
  setupInstana();
}
Future<void> setupInstana() async {
    await InstanaAgent.setup(key: 'Your-Instana-Key', reportingUrl: 'Your-Instana-Reporting-URL', null);

    // Alternatively with configuration options
    var options = SetupOptions();
    options.collectionEnabled = false;
    await InstanaAgent.setup(key: 'Your-Instana-Key', reportingUrl: 'Your-Instana-Reporting-URL', options: options);
}

```

--------------------------------

### Example: Setting user ID, email, and name in Application.onCreate

Source: https://www.ibm.com/docs/en/instana-observability/saas?topic=applications-android-api

Shows how to set user-specific information during app startup. The example sets userId, userEmail, and userName after Instana.setup. This must be done as early as possible because data already transmitted cannot be retroactively updated.

```kotlin
class MyApp : Application() {

    override fun onCreate() {
        super.onCreate()
        Instana.setup(
            this,
            InstanaConfig(
                key = BuildConfig.INSTANA_KEY,
                reportingURL = BuildConfig.INSTANA_REPORTING_URL
            )
        )
        Instana.userId = "1234567890"
        Instana.userEmail = "instana@example.com"
        Instana.userName = "instana android agent demo"
    }
}
 
```

--------------------------------

### Agent self-profiler log output

Source: https://www.ibm.com/docs/en/instana-observability/saas?topic=configurations-managing-host-agents

Example agent log output showing that the self-profiler has started and is installed. The profiler runs for 10 minutes.

```log
2025-03-19T14:21:48.077+00:00 | INFO  | instana-executor-thread-2-1      | ndRequestHandler | com.instana.agent-self-profiling - 1.0.0 | Starting Agent profiler for 10 minutes
2025-03-19T14:21:52.998+00:00 | INFO  | instana-scheduler-thread-3-4     | Profiler         | com.instana.agent-self-profiling - 1.0.0 | Profiler installed
```

--------------------------------

### Agent configuration: filter Redis operations with pattern matching

Source: https://www.ibm.com/docs/en/instana-observability/saas?topic=ruby-configuration-configuring-instana-gem

Agent configuration example to filter Redis commands that start with 'get' using match_type 'startswith'.

```yaml
tracing:
  filter:
    exclude:
      - name: "Redis GET operations"
        attributes:
          - key: "redis.command"
            values: ["get"]
            match_type: "startswith"

```

--------------------------------

### Alpine Dockerfile with build dependencies for native add-ons

Source: https://www.ibm.com/docs/en/instana-observability/saas?topic=agents-aws-fargate

Example Dockerfile snippet for Linux Alpine to install build dependencies temporarily and avoid metrics loss. The packages are removed after setup.

```dockerfile
COPY --from=icr.io/instana/aws-fargate-nodejs: latest /instana /instana
RUN apk add --no-cache --virtual .gyp \
        build-base \
        python \
    && /instana/setup.sh \
    && apk del .gyp python
ENV NODE_OPTIONS="--require /instana/node_modules/@instana/aws-fargate"
```

--------------------------------

### Example 2: Build and run commands

Source: https://www.ibm.com/docs/en/instana-observability/saas?topic=suntd-setting-up-net-tracing-docker-instana-base-images

Build and run commands for the multi-stage Dockerfile example, including Instana environment variables.

```bash
# Build Docker image (this also builds your application)
docker build -t myapp:latest .

# Run with Instana configuration
docker run -d \
  -e INSTANA_AGENT_KEY="your-instana-agent-key" \
  -e INSTANA_ENDPOINT_URL="serverless-end-point-url" \
  -e INSTANA_SERVICE_NAME=my-service \
  -p 8080:8080 \
  myapp:latest
```

--------------------------------

### Example index.html for $$ command

Source: https://www.ibm.com/docs/en/instana-observability/saas?topic=scripts-browser-api-reference

Example HTML file used to demonstrate the $$ command.

```html
<ul id="menu">
  <li><a href="/">Home</a></li>
  <li><a href="/">Developer Guide</a></li>
  <li><a href="/">API</a></li>
  <li><a href="/">Contribute</a></li>
</ul>

```

--------------------------------

### Debian-based Dockerfile with build dependencies for native add-ons

Source: https://www.ibm.com/docs/en/instana-observability/saas?topic=agents-aws-fargate

Example Dockerfile snippet for Debian-based distributions (including Ubuntu) to install build dependencies temporarily and avoid metrics loss. The packages are removed after setup.

```dockerfile
COPY --from=icr.io/instana/aws-fargate-nodejs:latest /instana /instana
RUN apt-get update \
    && apt-get install build-essential \
    && /instana/setup.sh \
    && apt-get remove -y build-essential
ENV NODE_OPTIONS="--require /instana/node_modules/@instana/aws-fargate"
```

--------------------------------

### Set up virtual environment and install Weaviate v3 packages

Source: https://www.ibm.com/docs/en/instana-observability/saas?topic=databases-weaviate

Creates and activates a virtual environment and installs the required packages for the Weaviate v3 client example: weaviate-client 3.26.7, ibm-watsonx-ai, and traceloop-sdk.

```bash
python3 -m venv .weaviate-v3
source .weaviate-v3/bin/activate
pip install "weaviate-client==3.26.7" ibm-watsonx-ai traceloop-sdk

```

--------------------------------

### Example: start and terminate session tracking

Source: https://www.ibm.com/docs/en/instana-observability/saas?topic=websites-javascript-agent-api

Example showing session tracking: starts tracking with default timeouts and later terminates the session.

```javascript
// Starts tracking sessions with the default timeouts
ineum('trackSessions');

// after some time…
ineum('terminateSession');
```

--------------------------------

### setup

Source: https://www.ibm.com/docs/en/instana-observability/saas?topic=applications-react-native-api

Initializes the Instana agent with the given key and reporting URL, and optionally enables slow sending mode.

```APIDOC
## setup

### Description
Initializes the Instana agent with the provided key and reporting URL, and optionally configures the slow sending mode.

### Method
setup

### Parameters
- **key** (string) - Required - The Instana agent key.
- **reportingUrl** (string) - Required - The URL to which beacons are reported.
- **options** (object) - Optional - Configuration options.
  - **slowSendInterval** (number) - Optional - The interval in seconds for slow sending mode. Valid range is 2-3600 seconds.

### Request Example
```typescript
Instana.setup('<your key>', '<your reporting url>', { slowSendInterval: 120.0 });
```

### Response
No return value.
```

--------------------------------

### Install Instana Collector Service

Source: https://www.ibm.com/docs/en/instana-observability/saas?topic=collectors-instana-distribution-opentelemetry-collector-idot

Installs the Instana Collector Service. The installation script installs and starts the service by default.

```bash
./instana_collector_service.sh install

```

--------------------------------

### Example 1: Build and run commands

Source: https://www.ibm.com/docs/en/instana-observability/saas?topic=suntd-setting-up-net-tracing-docker-instana-base-images

Build and run commands for the simple ASP.NET Core application, including Instana environment variables.

```bash
# Build your application
dotnet publish -c Release -o ./publish

# Build Docker image
docker build -t myapp:latest .

# Run with Instana configuration
docker run -d \
  -e INSTANA_AGENT_KEY="your-instana-agent-key" \
  -e INSTANA_ENDPOINT_URL="serverless-end-point-url" \
  -e INSTANA_SERVICE_NAME=my-service \
  -p 8080:8080 \
  myapp:latest
```

--------------------------------

### Native HTTP monitoring setup example

Source: https://www.ibm.com/docs/en/instana-observability/saas?topic=applications-flutter-monitoring-api

Example of enabling native HTTP monitoring by setting captureNativeHttp to true in SetupOptions during setup. The setup call returns a boolean; if false, an error is handled in debug mode.

```dart
@override
void initState() {
  super.initState();
  setupInstana();
}
Future<void> setupInstana() async {
  var options = SetupOptions(captureNativeHttp: true);
  await InstanaAgent.setup(key: 'Your-Instana-Key', reportingUrl: 'Your-Instana-Reporting-URL', options: options);
  if (!ret) {
    // Error handling here
    if (kDebugMode) {
      print("InstanaAgent setup failed");
    }
  }
}

```

--------------------------------

### Check init-container logs (manual setup)

Source: https://www.ibm.com/docs/en/instana-observability/saas?topic=tnft-troubleshooting-net-framework-tracing-amazon-eks-windows-nodes

Check the init-container logs to verify that the profiler files were copied successfully. For manual setup, replace <init-container-name> with the name you gave the init-container in your deployment manifest.

```bash
kubectl logs <pod-name> -c <init-container-name> -n <app-namespace>
```

--------------------------------

### Basic Instana iOS agent setup in didFinishLaunchingWithOptions

Source: https://www.ibm.com/docs/en/instana-observability/saas?topic=applications-ios-api

Shows the minimal setup for the Instana iOS agent in the app delegate's didFinishLaunchingWithOptions method. Replace the placeholder key and URL with your Instana credentials.

```swift
import InstanaAgent

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey : Any]? = nil) -> Bool {
    Instana.setup(key: "<Your Instana Key>", reportingURL: URL(string: "<Your Instana URL>")!)
    ....
    return true
}
 
```

--------------------------------

### Install Python Packages for Multiple-Collections RAG Example

Source: https://www.ibm.com/docs/en/instana-observability/saas?topic=databases-milvus

Installs additional Python packages needed for the multiple-collections RAG example, including langchain-huggingface, langchain-text-splitters, langchain-community, sentence-transformers, and pypdf.

```bash
pip install pymilvus traceloop-sdk ibm-watsonx-ai langchain-ibm \
    langchain-huggingface langchain-text-splitters langchain-community \
    sentence-transformers pypdf
```

--------------------------------

### Install LiteLLM proxy and Traceloop SDK

Source: https://www.ibm.com/docs/en/instana-observability/saas?topic=litellm-proxy

Installs the LiteLLM proxy package and the Traceloop SDK. Run this before creating the proxy configuration file.

```bash
pip install 'litellm[proxy]' traceloop-sdk
```

--------------------------------

### Install supported Pinecone version

Source: https://www.ibm.com/docs/en/instana-observability/saas?topic=databases-pinecone

Install the supported Pinecone version for the REST and gRPC example. Use `pinecone[grpc]==8.1.0` for the REST and gRPC example, or `pinecone==8.1.0` for the REST-only example. Required when `pip show pinecone` reports version 9 or later.

```bash
pip install "pinecone[grpc]==8.1.0"
```

--------------------------------

### Set up Weaviate v4 virtual environment

Source: https://www.ibm.com/docs/en/instana-observability/saas?topic=databases-weaviate

Leaves the v3 virtual environment, creates and activates a new one, and installs the required packages for the Weaviate v4 client example.

```bash
deactivate
python3 -m venv .weaviate-v4
source .weaviate-v4/bin/activate
pip install "weaviate-client==4.4.0" ibm-watsonx-ai traceloop-sdk
```

--------------------------------

### Weaviate v4 client with watsonx.ai

Source: https://www.ibm.com/docs/en/instana-observability/saas?topic=databases-weaviate

Weaviate v4 client example using the Collections API with IBM watsonx.ai for embeddings and chat summarization. It runs in five steps: collection setup and writes (`get`, `create`, `create_from_dict`, `delete`, and data `insert`, `replace`, `update`, and batch `add_object`), the modern query API (`fetch_object_by_id`, `fetch_objects`, and `near_vector`), the legacy GraphQL builders (`GetBuilder.do` and `AggregateBuilder.do`), a watsonx.ai summary of the query results, and raw GraphQL with cleanup (`graphql_raw_query` and `delete_all`). The v4 client no longer exposes the GraphQL builders, so the example also creates a legacy `weaviate.Client`, which is still bundled inside the `weaviate-client` package, to reach `client.query.get(...).do()` and `client.query.aggregate(...).do()`. As in the v3 example, the file adds `weaviate` to Traceloop's list of installed packages before it calls `Traceloop.init()`. Keep that line if you adapt this example for your own application.

```python
import os
import time

import weaviate
import traceloop.sdk.utils.package_check as package_check
from ibm_watsonx_ai import Credentials
from ibm_watsonx_ai.foundation_models import Embeddings, ModelInference
from traceloop.sdk import Traceloop
from traceloop.sdk.decorators import workflow, task
from weaviate.classes.config import Configure, DataType, Property
from weaviate.exceptions import UnexpectedStatusCodeError

package_check.installed_packages.add("weaviate")

Traceloop.init(app_name="weaviate_v4_client_watsonx_app")

WATSONX_CREDENTIALS = Credentials(
    url=os.environ["WATSONX_URL"],
    api_key=os.environ["WATSONX_API_KEY"],
)
WATSONX_PROJECT_ID = os.environ["WATSONX_PROJECT_ID"]

EMBEDDING_MODEL_ID = "ibm/granite-embedding-278m-multilingual"
CHAT_MODEL_ID = "ibm/granite-4-h-small"

WEAVIATE_HOST = os.environ.get("WEAVIATE_HOST", "localhost")
WEAVIATE_URL = os.environ.get("WEAVIATE_URL", f"http://{WEAVIATE_HOST}:8080")

MAIN_COLLECTION = "SeptWeaviateV4Document"
BULK_COLLECTION = "SeptWeaviateV4Note"

AI_ML = "AI/ML"
TECHNOLOGY = "Technology"
HEALTHCARE = "Healthcare"

SAMPLE_DOCS = [
    ("Machine learning algorithms learn patterns from data.", AI_ML),
    ("Neural networks are inspired by biological neurons.", AI_ML),
    ("Deep learning powers modern computer vision.", AI_ML),
    ("Cloud computing provides scalable infrastructure.", TECHNOLOGY),
    ("Blockchain enables decentralized trust.", TECHNOLOGY),
    ("Telemedicine enables remote patient consultations.", HEALTHCARE),
]


@task(name="setup_collections_and_write")
def setup_collections_and_write(client: weaviate.WeaviateClient, embedder: Embeddings, docs):
    for name in (MAIN_COLLECTION, BULK_COLLECTION):
        if client.collections.exists(name):
            client.collections.delete(name)

    client.collections.create(
        name=MAIN_COLLECTION,
        properties=[
            Property(name="text", data_type=DataType.TEXT),
            Property(name="category", data_type=DataType.TEXT),
        ],
        vectorizer_config=Configure.Vectorizer.none(),
    )

    client.collections.create_from_dict(
        {
            "class": BULK_COLLECTION,
            "vectorizer": "none",
            "properties": [{"name": "text", "dataType": ["text"]}],
        }
    )

    client.collections.delete(BULK_COLLECTION)

    collection = client.collections.get(MAIN_COLLECTION)

    texts = [text for text, _ in docs]
    categories = [category for _, category in docs]
    vectors = embedder.embed_documents(texts)

    direct = list(zip(texts[:2], categories[:2], vectors[:2]))
    batch = list(zip(texts[2:], categories[2:], vectors[2:]))

    inserted_ids = []
    for text, category, vector in direct:
        object_id = collection.data.insert(properties={"text": text, "category": category}, vector=vector)
        inserted_ids.append(object_id)

    updated_text = "Deep learning transforms modern computer vision entirely."
    updated_vector = embedder.embed_query(updated_text)
    collection.data.replace(
        uuid=inserted_ids[0], properties={"text": updated_text, "category": AI_ML}, vector=updated_vector
    )
```

--------------------------------

### Install auto-instrumentation libraries

Source: https://www.ibm.com/docs/en/instana-observability/saas?topic=integration-php-opentelemetry-exporter

Install the required instrumentation libraries for your application. The example shows installing the curl and WordPress instrumentation libraries via Composer.

```bash
composer require open-telemetry/opentelemetry-auto-curl
composer require open-telemetry/opentelemetry-auto-wordpress

```

--------------------------------

### Manual installation CL commands

Source: https://www.ibm.com/docs/en/instana-observability/saas?topic=instances-i-ile-tracing-sdk-public-preview

Run these CL commands to manually install the SDK when the installation script cannot be used. They create a save file, restore objects, and delete the save file.

```cl
CRTSAVF FILE(QGPL/TRACESAVF)
CPYFRMSTMF FROMSTMF('/opt/instana/ibmi-tracing/TRACESAVF.SAVF') +
  TOMBR('/QSYS.LIB/QGPL.LIB/TRACESAVF.FILE') MBROPT(*REPLACE)
CRTLIB LIB(RPGTRACE)
RSTOBJ OBJ(*ALL) SAVLIB(RPGTRACE) DEV(*SAVF) +
  SAVF(QGPL/TRACESAVF) RSTLIB(RPGTRACE)
DLTF FILE(QGPL/TRACESAVF)
```

--------------------------------

### Example: Get and log page load ID

Source: https://www.ibm.com/docs/en/instana-observability/saas?topic=websites-javascript-agent-api

Example of retrieving and logging the page load ID.

```javascript
var pageLoadId = ineum('getPageLoadId');
console.log(pageLoadId);
```

--------------------------------

### Example 2: Multi-stage Dockerfile

Source: https://www.ibm.com/docs/en/instana-observability/saas?topic=suntd-setting-up-net-tracing-docker-instana-base-images

Multi-stage Dockerfile that builds the application with the .NET SDK and uses an Instana runtime base image. Includes a commented alternative using the latest tag.

```dockerfile
# Build stage
FROM mcr.microsoft.com/dotnet/sdk:10.0 AS build
WORKDIR /src
COPY ["MyApp.csproj", "./"]
RUN dotnet restore
COPY . .
RUN dotnet publish -c Release -o /app/publish

# Runtime stage with Instana (using specific version)
FROM artifact-public.instana.io/dotnet-tracers/dotnet-runtime-10.0-noble-arm64:1.319.7

# Or use latest tag to get the most recent version
# FROM artifact-public.instana.io/dotnet-tracers/dotnet-runtime-10.0-noble-arm64:latest

WORKDIR /app
COPY --from=build /app/publish .
ENTRYPOINT ["dotnet", "MyApp.dll"]
```

--------------------------------

### Start the host agent Windows service

Source: https://www.ibm.com/docs/en/instana-observability/saas?topic=windows-installing-agent

Run this command to start the installed host agent Windows service.

```batch
net start instana-agent-service

```
Tokens:
Raw