> For the complete documentation index, see [llms.txt](https://docs.airops.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.airops.com/docs/pt/insights/onsite/traffic/cloudflare-worker-agent-analytics.md).

# Cloudflare Worker

Este guia mostra como configurar um Cloudflare Worker para transmitir registos de pedidos para o AirOps para Agent Analytics.

Este guia mostra como configurar o Cloudflare para transmitir para o AirOps via **Workers**. Depois de ligado, o AirOps analisa automaticamente o seu tráfego, classifica as visitas de bots de IA (ChatGPT, Claude, Perplexity, Google e outros) e apresenta insights no seu painel Agent Analytics.

{% hint style="info" %}
**Logpush ou Worker?** Se estiver num plano Cloudflare Enterprise, recomendamos [Cloudflare Logpush](https://docs.airops.com/docs/pt/insights/onsite/traffic/cloudflare-logpush-agent-analytics.md) em vez disso. É a opção mais fácil e não requer código. Use Workers quando o Logpush não estiver disponível, como em planos não Enterprise.
{% endhint %}

***

## Pré-requisitos

* Uma **AirOps** conta ativa com Agent Analytics ativado
* Uma **conta Cloudflare** que sirva o seu website e que esteja no nível Enterprise ou tenha o complemento Workers Paid
* Uma máquina de desenvolvimento com Node.js instalado
* A sua **chave de API do Workspace**, disponível em `Definições → Workspace`
* A sua **ID do Brand Kit**, disponível no URL ao navegar para `Context → Brand Kits`. O URL assume a forma `https://app.airops.com/<YOUR_WORKSPACE_SLUG>/data/brand_kits/<YOUR_BRAND_KIT_ID>`

***

## Agrupamento com Workers

A integração de agrupamento é a **recomendada** para a maioria dos websites. Usa uma fila da Cloudflare para armazenar em buffer os eventos de registo por pedido e enviá-los para o AirOps em lotes, mantendo-o bem abaixo do limite de taxa do AirOps mesmo com volumes elevados de tráfego.

### Passo 1: Inicialize o Cloudflare Worker

Para este processo, usaremos a versão `2.68.2` da CLI do Cloudflare. Outras versões menores podem funcionar, mas pode haver diferenças nos prompts da CLI.

{% hint style="info" %}
Dependendo do seu ambiente de desenvolvimento, poderá ser necessário instalar manualmente os seguintes pacotes node: `node-addon-api`, `node-gyp`, e `sharp`.
{% endhint %}

```bash
npm create cloudflare@2.68.2
```

Defina o diretório para `airops-log-collector`.

<figure><img src="https://31915162-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FX2n5yPRPynbnWuO4SH0M%2Fuploads%2Fgit-blob-d3a82ed25616b153b6eb6c41dda860f1162cc66f%2Fcloudflare-workers-01-directory.png?alt=media" alt=""><figcaption></figcaption></figure>

Defina o exemplo inicial para `exemplo Hello World`.

<figure><img src="https://31915162-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FX2n5yPRPynbnWuO4SH0M%2Fuploads%2Fgit-blob-6a28ae22cd704f476ba29a5fa1df7a42b9a99b03%2Fcloudflare-workers-02-project-example.png?alt=media" alt=""><figcaption></figcaption></figure>

Defina o template para `Worker consumidor e produtor da fila`.

<figure><img src="https://31915162-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FX2n5yPRPynbnWuO4SH0M%2Fuploads%2Fgit-blob-d40a4b5afebeebd3322857bbad322cec2f01addb%2Fcloudflare-workers-03-batch-template.png?alt=media" alt=""><figcaption></figcaption></figure>

TypeScript `TypeScript`.

<figure><img src="https://31915162-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FX2n5yPRPynbnWuO4SH0M%2Fuploads%2Fgit-blob-06e645b730047ef5c67a980815390d43a54effba%2Fcloudflare-workers-04-language.png?alt=media" alt=""><figcaption></figcaption></figure>

Escolha **Sim** para usar git para controlo de versões.

<figure><img src="https://31915162-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FX2n5yPRPynbnWuO4SH0M%2Fuploads%2Fgit-blob-9bbaf28aa13bf1c613af4e0628740b1d2a86fe94%2Fcloudflare-workers-05-git.png?alt=media" alt=""><figcaption></figcaption></figure>

Escolha **Não** para implementar a sua aplicação (faremos isso mais tarde).

<figure><img src="https://31915162-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FX2n5yPRPynbnWuO4SH0M%2Fuploads%2Fgit-blob-bdb363dcdf8ddde3f76b8bcc194361f9b46905d1%2Fcloudflare-workers-06-deploy.png?alt=media" alt=""><figcaption></figcaption></figure>

### Passo 2: Configure a rota do Cloudflare Worker

Edite o `wrangler.json` ficheiro e configure o seu `padrão`, `zone_name`, as ligações da fila e `AIROPS_API_URL`.

{% hint style="info" %}
A `padrão` deve ser o seu domínio real ou o URL do site de destino, enquanto o `zone_name` deve ser o domínio canónico. Por exemplo, se o seu site de destino for `https://blog.example.com`, o `padrão` deve ser `blog.example.com` e o seu `zone_name` deve ser `example.com`.
{% endhint %}

```json
{
  "$schema": "node_modules/wrangler/config-schema.json",
  "name": "airops-log-collector",
  "main": "src/index.ts",
  "compatibility_date": "2026-05-18",
  "observability": {
    "enabled": true
  },
  "queues": {
    "consumers": [
      {
        "queue": "airops-log-collector-queue",
        "max_batch_size": 1000,
        "max_batch_timeout": 60
      }
    ],
    "producers": [
      {
        "binding": "AIROPS_LOG_COLLECTOR_QUEUE",
        "queue": "airops-log-collector-queue"
      }
    ]
  },
  "upload_source_maps": true,
  "compatibility_flags": [
    "nodejs_compat"
  ],
  "route": {
    "pattern": "example.com/*",
    "zone_name": "example.com"
  },
  "vars": {
    "AIROPS_API_URL": "https://ingest.airops.com/api/v1/cloudflare-worker/<YOUR_BRAND_KIT_ID>/ingest"
  }
}
```

### Passo 3: Configure o código do Cloudflare Worker

Substitua o conteúdo do `src/index.ts` ficheiro pelo seguinte código.

```typescript
export interface Env {
  AIROPS_API_URL: string;
  AIROPS_API_KEY: string;
  AIROPS_LOG_COLLECTOR_QUEUE: Queue;
}

export default {
  // O produtor da fila é invocado em cada visita à página e guarda os metadados do pedido na fila
  async fetch(request: Request, env: Env, ctx: ExecutionContext): Promise<Response> {
    // Guardar a hora em que o pedido começou
    const startTime = Date.now();

    // Fazer o pedido
    const response = await fetch(request);

    // Clonar a resposta para que possa ser reutilizada
    const responseClone = response.clone();

    ctx.waitUntil(handleRequest(startTime, request, responseClone, env));
    return response;
  },

  // O consumidor da fila lê mensagens da fila e envia lotes periódicos para o AirOps
  async queue(batch: MessageBatch<string>, env: Env): Promise<void> {
    const body = batch.messages.map(m => m.body).join('\n');

    await fetch(env.AIROPS_API_URL, {
      method: 'POST',
      headers: {
        'Content-Type': 'application/json',
        'X-API-Key': env.AIROPS_API_KEY,
      },
      body,
    }).catch(error => console.error('Falha ao enviar registos:', error))
  }
} satisfies ExportedHandler<Env, string>;

async function handleRequest(startTime: number, request: Request, response: Response, env: Env) {
  const logData = {
    request_start_time: startTime,
    request_end_time: Date.now(),
    status_code: response.status,
    response_bytes: response.bytes.length,
    method: request.method,
    url: request.url,
    user_agent: request.headers.get('user-agent'),
    referer: request.headers.get('referer'),
  };

  await env.AIROPS_LOG_COLLECTOR_QUEUE.send(JSON.stringify(logData));
}
```

### Passo 4: Configure a chave de API do AirOps

{% hint style="info" %}
A sua `AIROPS_API_KEY` deve ser definida com o mesmo valor que a sua chave de API do Workspace, disponível em `Definições → Workspace`.
{% endhint %}

```bash
# Inicie sessão no Cloudflare
npx wrangler login

# Configure a chave de API
npx wrangler secret put AIROPS_API_KEY
```

<figure><img src="https://31915162-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FX2n5yPRPynbnWuO4SH0M%2Fuploads%2Fgit-blob-e819bcce3dcd2051f4b685120cc1796c628e0f8d%2Fagent-worker-01-setup-panel.png?alt=media" alt="Set up Agent Analytics panel for Cloudflare Worker with the ingest endpoint URL and workspace API token to copy"><figcaption><p>Copie os valores do AirOps para a configuração do Cloudflare Worker.</p></figcaption></figure>

### Passo 5: Crie a fila da Cloudflare

```bash
npx wrangler queues create airops-log-collector-queue
```

### Passo 6: Faça o deploy do Cloudflare Worker

```bash
# Faça o deploy do Cloudflare Worker
npx wrangler deploy
```

### Passo 7: Verifique a ligação

Depois de fazer o deploy do Cloudflare Worker, os dados deverão começar a fluir dentro de **2-5 minutos**.

1. Gere algum tráfego para o seu website.
2. No seu **painel AirOps**, navegue para **Agent Analytics**. Os dados de tráfego deverão aparecer em breve.

***

## Alternativa com Workers

A abordagem alternativa de integração envia um evento para o AirOps em cada visita à página. Isto é mais adequado para websites com menos visitas à página para evitar exceder os limites de taxa e, por isso, não é recomendado para a maioria dos websites.

### Passo 1: Inicialize o Cloudflare Worker

Para este processo, usaremos a versão `2.68.2` da CLI do Cloudflare. Outras versões menores podem funcionar, mas pode haver diferenças nos prompts da CLI.

{% hint style="info" %}
Dependendo do seu ambiente de desenvolvimento, poderá ser necessário instalar manualmente os seguintes pacotes node: `node-addon-api`, `node-gyp`, e `sharp`.
{% endhint %}

```bash
npm create cloudflare@2.68.2
```

Defina o diretório para `airops-log-collector`.

<figure><img src="https://31915162-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FX2n5yPRPynbnWuO4SH0M%2Fuploads%2Fgit-blob-d3a82ed25616b153b6eb6c41dda860f1162cc66f%2Fcloudflare-workers-01-directory.png?alt=media" alt=""><figcaption></figcaption></figure>

Defina o exemplo inicial para `exemplo Hello World`.

<figure><img src="https://31915162-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FX2n5yPRPynbnWuO4SH0M%2Fuploads%2Fgit-blob-6a28ae22cd704f476ba29a5fa1df7a42b9a99b03%2Fcloudflare-workers-02-project-example.png?alt=media" alt=""><figcaption></figcaption></figure>

Defina o template para `Apenas Worker`.

<figure><img src="https://31915162-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FX2n5yPRPynbnWuO4SH0M%2Fuploads%2Fgit-blob-47978f6b8874aeb95c2b8401bcc062ab98c15ee9%2Fcloudflare-workers-03-alternate-template.png?alt=media" alt=""><figcaption></figcaption></figure>

TypeScript `TypeScript`.

<figure><img src="https://31915162-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FX2n5yPRPynbnWuO4SH0M%2Fuploads%2Fgit-blob-06e645b730047ef5c67a980815390d43a54effba%2Fcloudflare-workers-04-language.png?alt=media" alt=""><figcaption></figcaption></figure>

Escolha **Sim** para usar git para controlo de versões.

<figure><img src="https://31915162-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FX2n5yPRPynbnWuO4SH0M%2Fuploads%2Fgit-blob-9bbaf28aa13bf1c613af4e0628740b1d2a86fe94%2Fcloudflare-workers-05-git.png?alt=media" alt=""><figcaption></figcaption></figure>

Escolha **Não** para implementar a sua aplicação (faremos isso mais tarde).

<figure><img src="https://31915162-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FX2n5yPRPynbnWuO4SH0M%2Fuploads%2Fgit-blob-bdb363dcdf8ddde3f76b8bcc194361f9b46905d1%2Fcloudflare-workers-06-deploy.png?alt=media" alt=""><figcaption></figcaption></figure>

### Passo 2: Configure a rota do Cloudflare Worker

Edite o `wrangler.json` ficheiro e configure o seu `padrão`, `zone_name`, e `AIROPS_API_URL`.

{% hint style="info" %}
A `padrão` deve ser o seu domínio real ou o URL do site de destino, enquanto o `zone_name` deve ser o domínio canónico. Por exemplo, se o seu site de destino for `https://blog.example.com`, o `padrão` deve ser `blog.example.com` e o seu `zone_name` deve ser `example.com`.
{% endhint %}

```json
{
  "$schema": "node_modules/wrangler/config-schema.json",
  "name": "airops-log-collector",
  "main": "src/index.ts",
  "compatibility_date": "2026-05-18",
  "observability": {
    "enabled": true
  },
  "upload_source_maps": true,
  "compatibility_flags": [
    "nodejs_compat"
  ],
  "route": {
    "pattern": "example.com/*",
    "zone_name": "example.com"
  },
  "vars": {
    "AIROPS_API_URL": "https://ingest.airops.com/api/v1/cloudflare-worker/<YOUR_BRAND_KIT_ID>/ingest"
  }
}
```

### Passo 3: Configure o código do Cloudflare Worker

Substitua o conteúdo do `src/index.ts` ficheiro pelo seguinte código.

```typescript
export interface Env {
  AIROPS_API_URL: string;
  AIROPS_API_KEY: string;
}

export default {
  async fetch(request: Request, env: Env, ctx: ExecutionContext): Promise<Response> {
    // Guardar a hora em que o pedido começou
    const startTime = Date.now();

    // Fazer o pedido
    const response = await fetch(request);

    // Clonar a resposta para que possa ser reutilizada
    const responseClone = response.clone();

    ctx.waitUntil(handleRequest(startTime, request, responseClone, env));
    return response;
  }
} satisfies ExportedHandler<Env>;

async function handleRequest(startTime: number, request: Request, response: Response, env: Env) {
	const logData = {
		request_start_time: startTime,
		request_end_time: Date.now(),
		status_code: response.status,
		response_bytes: response.bytes.length,
		method: request.method,
		url: request.url,
		user_agent: request.headers.get('user-agent'),
		referer: request.headers.get('referer'),
    }

  await fetch(env.AIROPS_API_URL, {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'X-API-Key': env.AIROPS_API_KEY
    },
    body: JSON.stringify(logData)
  }).catch(error => console.error('Falha ao enviar registos:', error))
}
```

### Passo 4: Configure a chave de API do AirOps

{% hint style="info" %}
A sua `AIROPS_API_KEY` deve ser definida com o mesmo valor que a sua chave de API do Workspace, disponível em `Definições → Workspace`.
{% endhint %}

```bash
# Inicie sessão no Cloudflare
npx wrangler login

# Configure a chave de API
npx wrangler secret put AIROPS_API_KEY
```

### Passo 5: Faça o deploy do Cloudflare Worker

```bash
# Faça o deploy do Cloudflare Worker
npx wrangler deploy
```

### Passo 6: Verifique a ligação

Depois de fazer o deploy do Cloudflare Worker, os dados deverão começar a fluir dentro de **2-5 minutos**.

1. Gere algum tráfego para o seu website.
2. No seu **painel AirOps**, navegue para **Agent Analytics**. Os dados de tráfego deverão aparecer em breve.

***

## Limites de taxa

O processador de entrada do AirOps impõe um limite de taxa de **5 pedidos por minuto por chave de API**. O Worker em tempo real envia um pedido por visita à página, pelo que esta opção é mais adequada para sites com menos tráfego. Para sites com muito tráfego, agrupe os pedidos ou use uma opção de ingestão com buffer.

***

## O que o AirOps monitoriza

Depois de ligado, o AirOps automaticamente:

* **Ingere todos os pedidos Cloudflare**: visualizações de página, ativos e chamadas à API
* **Classifica o tráfego de bots de IA**: identifica visitas de ChatGPT, Claude, Google, Perplexity, Meta, Apple, Bing, Bytedance, Common Crawl e outros
* **Categoriza o comportamento de crawl**: distingue entre crawlers de treino de IA, fetches de pesquisa de IA, indexação de IA e navegação em IA iniciada pelo utilizador
* **Exibe análises**: repartições de tráfego, rácios bot vs. humano e tendências de crawl no seu painel


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.airops.com/docs/pt/insights/onsite/traffic/cloudflare-worker-agent-analytics.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
