diff --git a/src/content/docs/ai-gateway/observability/analytics.mdx b/src/content/docs/ai-gateway/observability/analytics.mdx index d82ced8070c4ef9..886ad5b904ba785 100644 --- a/src/content/docs/ai-gateway/observability/analytics.mdx +++ b/src/content/docs/ai-gateway/observability/analytics.mdx @@ -1,5 +1,5 @@ --- -title: Analytics and logging +title: Analytics pcx_content_type: reference --- @@ -42,12 +42,3 @@ curl https://api.cloudflare.com/client/v4/graphql \ ``` - -:::note[Note] - -The cost metric is an estimation based on the number of tokens sent and received in requests. While this metric can help you monitor and predict cost trends, refer to your provider’s dashboard for the most accurate cost details. -::: - -## Logging - -Your AI Gateway dashboard also shows real-time logs of individual requests, such as the prompt, response, provider, timestamps, and whether the request was successful, cached, or if there was an error. These logs now persist and can store up to 10,000 logs per gateway for better observability and analysis. diff --git a/src/content/docs/ai-gateway/observability/costs.mdx b/src/content/docs/ai-gateway/observability/costs.mdx index 65399970f1b5698..a6e43fd2bc3444f 100644 --- a/src/content/docs/ai-gateway/observability/costs.mdx +++ b/src/content/docs/ai-gateway/observability/costs.mdx @@ -1,9 +1,10 @@ --- title: Costs pcx_content_type: reference +sidebar: + order: 2 --- - ## Supported Providers AI Gateway currently supports cost metrics from the following providers: @@ -28,7 +29,6 @@ The cost metric is an **estimation** based on the number of tokens sent and rece :::caution[Caution] - Providers may introduce new models or change their pricing. If you notice outdated cost data or are using a model not yet supported by our cost tracking, please [submit a request](https://forms.gle/8kRa73wRnvq7bxL48) ::: @@ -37,6 +37,3 @@ Providers may introduce new models or change their pricing. If you notice outdat AI Gateway allows users to set custom costs when operating under special pricing agreements or negotiated rates. Custom costs can be applied at the request level, and when applied, they will override the default or public model costs. For more information on configuration of custom costs, please visit the [Custom Costs](/ai-gateway/configuration/custom-costs/) configuration page. - - - diff --git a/src/content/docs/ai-gateway/observability/logging/index.mdx b/src/content/docs/ai-gateway/observability/logging/index.mdx new file mode 100644 index 000000000000000..f19ecedf58d2c38 --- /dev/null +++ b/src/content/docs/ai-gateway/observability/logging/index.mdx @@ -0,0 +1,56 @@ +--- +pcx_content_type: reference +title: Logging +sidebar: + badge: + text: Beta +--- + +import { Render } from "~/components"; + +Logging is a fundamental building block for application development. Logs provide insights during the early stages of development and are often critical to understanding issues occurring in production. + +Your AI Gateway dashboard shows logs of individual requests, including the user prompt, model response, provider, timestamp, request status, token usage, cost, and duration. These logs persist, giving you the flexibility to store them for your preferred duration and do more with valuable request data. + +You can store up to 10 million logs per gateway. If your limit is reached, new logs will stop being saved. To continue saving logs, you must delete older logs to free up space for new logs. + +To learn more about your plan limits, refer to [Pricing](/ai-gateway/pricing/). + +## Default configuration + +Logs, which include metrics as well as request and response data, are enabled by default for each gateway. This logging behavior will be uniformly applied to all requests in the gateway. If you are concerned about privacy or compliance and want to turn log collection off, you can go to settings and opt out of logs. If you need to modify the log settings for specific requests, you can override this setting on a per-request basis. + + + +:::note + +To export logs using [Logpush](/ai-gateway/observability/logging/logpush), you must have logs turned on for the gateway. + +::: + +## Per-request logging + +To override the default logging behavior set in the settings tab, you can define headers on a per-request basis. + +## Collect logs (`cf-aig-collect-log`) + +The `cf-aig-collect-log` header allows you to bypass the default log setting for the gateway. If the gateway is configured to save logs, the header will exclude the log for that specific request. Conversely, if logging is disabled at the gateway level, this header will save the log for that request. + +In the example below, we use `cf-aig-collect-log` to bypass the default setting to avoid saving the log. + +```bash +curl https://gateway.ai.cloudflare.com/v1/{account_id}/{gateway_id}/openai/chat/completions \ + --header 'Authorization: Bearer $TOKEN' \ + --header 'Content-Type: application/json' \ + --header 'cf-aig-collect-log: false \ + --data ' { + "model": "gpt-4o-mini", + "messages": [ + { + "role": "user", + "content": "What is the email address and phone number of user123?" + } + ] + } +' +``` diff --git a/src/content/partials/ai-gateway/logging.mdx b/src/content/partials/ai-gateway/logging.mdx new file mode 100644 index 000000000000000..192179ae55d37b4 --- /dev/null +++ b/src/content/partials/ai-gateway/logging.mdx @@ -0,0 +1,10 @@ +--- +{} +--- + +To change the default log configuration in the dashboard: + +1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/) and select your account. +2. Go to **AI** > **AI Gateway**. +3. Select **Settings**. +4. Change the **Logs** setting to your preference.