Skip to content

Commit 65dea83

Browse files
Improve error handling and documentation clarity (cloudflare#22450)
* Hyperlint Automation Fix * Hyperlint Automation Fix * Hyperlint Automation Fix * Hyperlint Automation Fix * Hyperlint Automation Fix * Hyperlint Automation Fix * Hyperlint Automation Fix * Hyperlint Automation Fix * Hyperlint Automation Fix * Hyperlint Automation Fix * Hyperlint Automation Fix * Hyperlint Automation Fix * Hyperlint Automation Fix * Hyperlint Automation Fix * Hyperlint Automation Fix * Hyperlint Automation Fix * Hyperlint Automation Fix * Hyperlint Automation Fix * Hyperlint Automation Fix * Hyperlint Automation Fix * Apply suggestions from code review --------- Co-authored-by: hyperlint-ai[bot] <154288675+hyperlint-ai[bot]@users.noreply.github.com> Co-authored-by: Kody Jackson <[email protected]>
1 parent 21cf731 commit 65dea83

File tree

5 files changed

+12
-12
lines changed

5 files changed

+12
-12
lines changed

src/content/docs/ai-gateway/guardrails/set-up-guardrail.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,14 @@ After enabling Guardrails, you can monitor results through **AI Gateway Logs** i
2828

2929
## Error handling and blocked requests
3030

31-
When a request is blocked by guardrails, you will receive a structured error response. These indicate whether the issue occurred with the prompt or the model response. Use error codes to differentiate between prompt versus response violations.
31+
When a request is blocked by guardrails, you will receive a structured error response. These indicate whether the issue occurred with the prompt or the model response. Use error codes to differentiate between prompt versus response violations.
3232

3333
- **Prompt blocked**
3434
- `"code": 2016`
3535
- `"message": "Prompt blocked due to security configurations"`
3636

3737
- **Response blocked**
38-
- `"code": 2017`
38+
- `"code": 2017`
3939
- `"message": "Response blocked due to security configurations"`
4040

4141
You should catch these errors in your application logic and implement error handling accordingly.

src/content/docs/analytics/account-and-zone-analytics/analytics-with-workers.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ For a breakdown of subrequest traffic (origin facing traffic), you may go to the
3131

3232
**Why do I not have any analytics for Workers?**
3333

34-
* If you are not currently using Workers (don't have Workers deployed on any routes or filters), we will not have any information to show you.
34+
* If you are not currently using Workers (do not have Workers deployed on any routes or filters), we will not have any information to show you.
3535
* If your Worker sends a static response back to the client without ever calling fetch() to an origin, you are not making any subrequests, thus, all traffic will be shown in zone Analytics
3636

3737
**Will this impact billing?** 

src/content/docs/analytics/account-and-zone-analytics/status-codes.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ You can filter out specific error(s) by selecting one or more in the legend. You
2222

2323
:::note
2424

25-
Users may also see `100x` errors which are not reported. These will be displayed as either `403` or `409` (edge) errors.
25+
Users may also see `100x` errors which are not reported. These will be displayed as either `403` or `409` (edge) errors.
2626
:::
2727

2828
![Error analytics by Cloudflare data center](~/assets/images/analytics/status-codes.png)

src/content/docs/analytics/analytics-integrations/looker.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -149,6 +149,6 @@ With the following pre-set filter values in the Looker dashboards all workers su
149149

150150
* **WorkerSubrequest** set to value *False*
151151

152-
* **ClientRequestMethod** doesn't equal to *PURGE*
152+
* **ClientRequestMethod** does not equal to *PURGE*
153153

154-
You can always adjust your default filters values according to your needs.
154+
You can always adjust your default filter values according to your needs.

src/content/docs/analytics/dashboards.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@ Custom dashboards allow you to create tailored dashboards to monitor application
1010

1111
Dashboards provide a visual interface that displays key metrics and analytics, helping you monitor and analyze data efficiently. Different dashboards serve different purposes. For example, a security dashboard tracks attack attempts and threats, a performance dashboard monitors API latency and uptime, and a usage dashboard analyzes traffic patterns and user behavior.
1212

13-
Different metrics serve distinct roles in providing insights into your applications performance. For example, total HTTP requests offers an overview of traffic volume, while average response time helps assess application speed. Additionally, usage metrics such as traffic patterns and user behavior provide insight into how users interact with your application. These metrics together enable you to spot trends, identify problems, and make informed, data-driven decisions.
13+
Different metrics serve distinct roles in providing insights into your application's performance. For example, total HTTP requests offers an overview of traffic volume, while average response time helps assess application speed. Additionally, usage metrics such as traffic patterns and user behavior provide insight into how users interact with your application. These metrics together enable you to spot trends, identify problems, and make informed, data-driven decisions.
1414

1515
:::note
16-
Custom Dashboards is currently available to customers participating in the Log Explorer beta. To begin using custom dashboards, you will first need to request access to [Log Explorer](/logs/log-explorer/).
16+
Custom Dashboards is currently available to customers participating in the Log Explorer beta. To begin using custom dashboards, you will first need to request access to [Log Explorer](/logs/log-explorer/).
1717
:::
1818

1919
## Create a new dashboard
@@ -29,14 +29,14 @@ Choosing between these options depends on whether you need a quick setup with pr
2929

3030
### Create a dashboard from scratch
3131

32-
When creating a dashboard from scratch, select the option **Create a new**. You can follow the instructions in the following sections to start adding charts to your dashboard.
32+
When creating a dashboard from scratch, select the option **Create a new**. You can follow the instructions in the following sections to start adding charts to your dashboard.
3333

3434
#### Create a new chart
3535

3636
To create a new chart, select **Add chart**. There are two ways to create a chart:
3737

38-
- **Use a prompt**: Enter a query like `Compare status code ranges over time`. The AI model decides the most appropriate visualization and constructs your chart configuration.
39-
- **Customize your chart**: Select the chart elements manually, including the chart type, title, dataset to query, metrics, and filters. This option gives you full control over your chart’s structure.
38+
- **Use a prompt**: Enter a query like `Compare status code ranges over time.` The AI model decides the most appropriate visualization and constructs your chart configuration.
39+
- **Customize your chart**: Select the chart elements manually, including the chart type, title, dataset to query, metrics, and filters. This option gives you full control over your chart’s structure.
4040

4141
Refer to the following sections for more information about the charts, datasets, fields, metrics, and filters available.
4242

@@ -79,7 +79,7 @@ Alternatively, you can choose to create your dashboard using a pre-designed dash
7979

8080
- **Bot monitoring**: Allows you to identify automated traffic accessing your website.
8181
- **API Security**: Allows you to monitor data transfers and exceptions for API endpoints in your application.
82-
- **API Performance**: Allows you to view timing data for API endpoints in your application, along with error rates.
82+
- **API Performance**: Allows you to view timing data for API endpoints in your application, along with error rates.
8383
- **Account takeover**: Allows you to monitor login attempts, usage of leaked credentials, and account takeover attacks.
8484

8585
## Edit a dashboard or chart

0 commit comments

Comments
 (0)