Integración de registros personalizada

​

Descripción general

​

Requisitos previos

• Tu Log Ingestion Token de Profound
• La capacidad de enviar solicitudes HTTP POST desde tu aplicación o infraestructura

​

Especificación de la API

​

Endpoint

POST https://artemis.api.tryprofound.com/v1/logs/custom

​

Autenticación

'x-api-key': 'bot_PROFOUND_LOG_INGESTION_TOKEN'

​

Formato de la solicitud

​

Campos obligatorios

• timestamp - Marca de tiempo del evento (marca de tiempo Unix o cadena ISO 8601)
• method - Método HTTP (máximo 10 caracteres)
• host - Nombre de host de la solicitud (máximo 255 caracteres)
• path - Ruta de la solicitud (máximo 2048 caracteres)
• status_code - Código de estado HTTP (rango: 100-599)
• ip - Dirección IP del cliente (máximo 45 caracteres)
• user_agent - Cadena de user agent (máximo 1024 caracteres)

​

Campos opcionales

• query_params - Parámetros de consulta (clave máx.: 100 caracteres, valor máx.: 1000 caracteres)
• referer - Referer de la solicitud (máximo 2048 caracteres)
• bytes_sent - Tamaño de la respuesta en bytes (debe ser >= 0)
• duration_ms - Duración de la solicitud en milisegundos (debe ser >= 0)

​

Guía de implementación

[
  {
    "timestamp": "2024-01-11T12:00:00Z",
    "method": "GET",
    "host": "example.com",
    "path": "/products",
    "status_code": 200,
    "ip": "192.168.1.1",
    "user_agent": "Mozilla/5.0...",
    "query_params": {
      "category": "electronics",
      "page": "1"
    },
    "referer": "https://example.com",
    "bytes_sent": 1024,
    "duration_ms": 150
  }
]

import requests
import json

logs = [{
    "timestamp": "2024-01-11T12:00:00Z",
    "method": "GET",
    "host": "example.com",
    "path": "/products",
    "status_code": 200,
    "ip": "192.168.1.1",
    "user_agent": "Mozilla/5.0..."
}]

response = requests.post(
    "https://artemis.api.tryprofound.com/v1/logs/custom",
    headers={
        "x-api-key": "bot_PROFOUND_LOG_INGESTION_TOKEN",
        "Content-Type": "application/json"
    },
    json=logs
)

print(response.json())

const axios = require('axios');

const logs = [{
    timestamp: "2024-01-11T12:00:00Z",
    method: "GET",
    host: "example.com",
    path: "/products",
    status_code: 200,
    ip: "192.168.1.1",
    user_agent: "Mozilla/5.0..."
}];

axios.post('https://artemis.api.tryprofound.com/v1/logs/custom', logs, {
    headers: {
        'x-api-key': 'bot_PROFOUND_LOG_INGESTION_TOKEN',
        'Content-Type': 'application/json'
    }
})
.then(response => console.log(response.data))
.catch(error => console.error(error));

{
  "status": "accepted",
  "message": "Processing X log entries",
  "first_visit_id": "uuid-string",
  "errors": []
}

{
  "status": "accepted",
  "message": "Processing 98 log entries",
  "first_visit_id": "uuid-string",
  "errors": [
    "Invalid log format: timestamp out of reasonable range",
    "Invalid log format: status_code must be between 100 and 599"
  ]
}

​

Gestión de errores

​

Errores de validación

• Seguirá procesando las entradas válidas del lote
• Agregará los errores de validación al array errors de la respuesta
• Devolverá un código de estado 200 con las entradas procesadas y los errores

​

Errores inesperados

• Devolverá un código de estado 500
• Devolverá un mensaje de error en el campo detail de la respuesta
• No procesará ninguna entrada del lote

​

Prácticas recomendadas

• Agrupa los registros en lotes de hasta 1000 entradas
• Implementa lógica de reintentos para las solicitudes fallidas
• Usa procesamiento en segundo plano para el envío de registros
• Envía los registros de forma asíncrona para no afectar al rendimiento de la aplicación
• Considera implementar un búfer local
• Usa compresión para cargas útiles grandes

​

Soporte

• Escribe a support@tryprofound.com para obtener ayuda

​

Consideraciones de seguridad

• Almacena los Log Ingestion Tokens de forma segura
• Rota los Log Ingestion Tokens con regularidad
• Supervisa los registros de solicitudes para detectar patrones inusuales
• Usa HTTPS para todas las solicitudes a la API