Metrics, logs, and alerts for your serverless APIs — with just a few lines of code.
\n \n
\n\n \n \n \n\n
\n \n\n# Apitally SDK for Cloudflare Workers\n\n[](https://github.com/apitally/apitally-js-serverless/actions)\n[](https://codecov.io/gh/apitally/apitally-js-serverless)\n[](https://www.npmjs.com/package/@apitally/serverless)\n\nApitally is a simple API monitoring and analytics tool that makes it easy to understand API usage, monitor performance, and troubleshoot issues.\nGet started in minutes by just adding a few lines of code and a Logpush job.\n\nLearn more about Apitally on our 🌎 [website](https://apitally.io) or check out\nthe 📚 [documentation](https://docs.apitally.io).\n\nThis SDK is for APIs running on [Cloudflare Workers](https://developers.cloudflare.com/workers/) and relies on [Logpush](https://developers.cloudflare.com/workers/observability/logs/logpush/) to send data to Apitally.\n\n## Key features\n\n### API analytics\n\nTrack traffic, error and performance metrics for your API, each endpoint and\nindividual API consumers, allowing you to make informed, data-driven engineering\nand product decisions.\n\n### Request logs\n\nDrill down from insights to individual API requests or use powerful search and filters to\nfind specific requests. View correlated application logs for a complete picture\nof each request, making troubleshooting faster and easier.\n\n### Error tracking\n\nUnderstand which validation rules in your endpoints cause client errors. Capture\nerror details and stack traces for 500 error responses.\n\n### API monitoring & alerts\n\nGet notified immediately if something isn't right using custom alerts and synthetic\nuptime checks. Alert notifications can be delivered via email, Slack and Microsoft Teams.\n\n## Supported frameworks\n\n| Framework | Supported versions | Setup guide |\n| ------------------------------------------ | ------------------ | --------------------------------------------------------------------- |\n| [**Hono**](https://github.com/honojs/hono) | `4.x` | [Link](https://docs.apitally.io/setup-guides/hono-cloudflare-workers) |\n\nApitally also supports many other web frameworks in [JavaScript](https://github.com/apitally/apitally-js), [Python](https://github.com/apitally/apitally-py), [Go](https://github.com/apitally/apitally-go), [.NET](https://github.com/apitally/apitally-dotnet) and [Java](https://github.com/apitally/apitally-java) via our other SDKs.\n\n## Getting started\n\nIf you don't have an Apitally account yet, first [sign up here](https://app.apitally.io/?signup).\n\n### 1. Create app in Apitally\n\nCreate an app in the Apitally dashboard and select **Hono (Cloudflare Workers)** as your framework. You'll see detailed setup instructions, which also include your client ID.\n\n### 2. Create Logpush job\n\nLog in to the [Cloudflare dashboard](https://dash.cloudflare.com/) and navigate to _Analytics & Logs > Logpush_. Create a [Logpush](https://developers.cloudflare.com/workers/observability/logs/logpush/) job with the following settings:\n\n| Setting | Value |\n| ---------------------------- | ---------------------------------------------------------------------------------- |\n| Destination | HTTP destination |\n| HTTP endpoint | `https://hub.apitally.io/v2/{client-id}/{env}/logpush` |\n| Dataset | Workers trace events |\n| If logs match... | Filtered logs: EventType equals `fetch` and ScriptName equals `{your-worker-name}` |\n| Send the following fields... | General: Event, EventTimestampMs, Logs |\n\nIn the HTTP endpoint, replace `{client-id}` with your app's client ID and `{env}` with the environment (e.g. `prod` or `dev`). In the filter criteria, replace `{your-worker-name}` with the name of your Worker, as specified in your Wrangler config.\n\n### 3. Configure Worker\n\nEnable [Workers Logs](https://developers.cloudflare.com/workers/observability/logs/workers-logs/) and [Logpush](https://developers.cloudflare.com/workers/observability/logs/logpush/) in your `wrangler.toml` configuration file:\n\n```toml\nlogpush = true\n\n[observability]\nenabled = true\nhead_sampling_rate = 1\n\n[observability.logs]\ninvocation_logs = true\n```\n\n### 4. Add middleware\n\nInstall the SDK:\n\n```bash\nnpm install @apitally/serverless\n```\n\nThen add the Apitally middleware to your Hono application using the `useApitally` function:\n\n```javascript\nimport { Hono } from \"hono\";\nimport { useApitally } from \"@apitally/serverless/hono\";\n\nconst app = new Hono();\n\nuseApitally(app, {\n logRequestHeaders: true,\n logRequestBody: true,\n logResponseHeaders: true,\n logResponseBody: true,\n});\n\n// Ensure route handlers are registered after useApitally()\n```\n\nFor further instructions, see our\n[setup guide for Hono on Cloudflare Workers](https://docs.apitally.io/setup-guides/hono-cloudflare-workers).\n\nSee the [SDK reference](https://docs.apitally.io/sdk-reference/javascript-serverless) for all available configuration options, including how to mask sensitive data, customize request logging, and more.\n\n## Getting help\n\nIf you need help please\n[create a new discussion](https://github.com/orgs/apitally/discussions/categories/q-a)\non GitHub or email us at [support@apitally.io](mailto:support@apitally.io). We'll get back to you as soon as possible.\n\n## License\n\nThis library is licensed under the terms of the [MIT license](LICENSE).\n","readmeFilename":"README.md"}
![\"Apitally](\"https://assets.apitally.io/logos/logo-horizontal-new-light.png\"){kind=logo}
\n ![\"Apitally](\"https://assets.apitally.io/screenshots/overview-light.png\")
\n