> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-mintlify-8a08bda2.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

> SDK Java para ClickStack - a stack de observabilidade da ClickHouse

# Java

O ClickStack usa o padrão OpenTelemetry para coletar dados de telemetria (logs e
traces). Os traces são gerados automaticamente com instrumentação automática, então a
instrumentação manual não é necessária para aproveitar o tracing.

**Este guia integra:**

<table>
  <tbody>
    <tr>
      <td className="pe-2">✅ Logs</td>
      <td className="pe-2">✅ Métricas</td>
      <td className="pe-2">✅ Traces</td>
    </tr>
  </tbody>
</table>

<div id="getting-started">
  ## Primeiros passos
</div>

<Note>
  No momento, a integração é compatível apenas com **Java 8+**
</Note>

<div id="download-opentelemetry-java-agent">
  ### Baixe o agente Java do OpenTelemetry
</div>

Baixe [`opentelemetry-javaagent.jar`](https://github.com/open-telemetry/opentelemetry-java-instrumentation/releases/latest/download/opentelemetry-javaagent.jar)
e coloque o JAR no diretório de sua preferência. O arquivo JAR contém o agente
e as bibliotecas de instrumentação. Você também pode usar o comando a seguir para
baixar o agente:

```shell theme={null}
curl -L -O https://github.com/open-telemetry/opentelemetry-java-instrumentation/releases/latest/download/opentelemetry-javaagent.jar
```

<div id="configure-environment-variables">
  ### Configure variáveis de ambiente
</div>

Em seguida, você precisará configurar as seguintes variáveis de ambiente no shell para enviar telemetria ao ClickStack por meio do OpenTelemetry Collector:

<Tabs>
  <Tab title="Managed ClickStack">
    ```shell theme={null}
    export JAVA_TOOL_OPTIONS="-javaagent:PATH/TO/opentelemetry-javaagent.jar" \
    OTEL_EXPORTER_OTLP_ENDPOINT=https://your-otel-collector:4318 \
    OTEL_EXPORTER_OTLP_PROTOCOL=http/protobuf \
    OTEL_LOGS_EXPORTER=otlp \
    OTEL_SERVICE_NAME='<NAME_OF_YOUR_APP_OR_SERVICE>'
    ```
  </Tab>

  <Tab title="ClickStack Open Source">
    ```shell theme={null}
    export JAVA_TOOL_OPTIONS="-javaagent:PATH/TO/opentelemetry-javaagent.jar" \
    OTEL_EXPORTER_OTLP_ENDPOINT=https://your-otel-collector:4318 \
    OTEL_EXPORTER_OTLP_HEADERS='authorization=<YOUR_INGESTION_API_KEY>' \
    OTEL_EXPORTER_OTLP_PROTOCOL=http/protobuf \
    OTEL_LOGS_EXPORTER=otlp \
    OTEL_SERVICE_NAME='<NAME_OF_YOUR_APP_OR_SERVICE>'
    ```
  </Tab>
</Tabs>

*A variável de ambiente `OTEL_SERVICE_NAME` é usada para identificar seu serviço no aplicativo HyperDX; ela pode ter qualquer nome.*

A variável de ambiente `OTEL_EXPORTER_OTLP_HEADERS` contém a chave de API disponível no aplicativo HyperDX em `Team Settings → API Keys`.

<div id="run-the-application-with-otel-java-agent">
  ### Inicie a aplicação com o agente Java do OpenTelemetry
</div>

```shell theme={null}
java -jar target/<APPLICATION_JAR_FILE>
```

<br />

Leia mais sobre a instrumentação Java do OpenTelemetry aqui: [https://opentelemetry.io/docs/instrumentation/java/](https://opentelemetry.io/docs/instrumentation/java/)