ApiTraffic helps engineering teams save development time so they can ship features faster.
Once you’ve integrated the ApiTraffic SDK into your application, each request/response will be sent to the ApiTraffic, processed, and will then appear within your desired bucket.
From within your ApiTraffic account you will see real-time requests to your API, API analytics, the load size of the response, etc.
Visit our knowledgebase for the complete documentation.
Data can be redacted either before it leaves your server or once it arrives to ApiTraffic for processing. Data redaction settings do not require any code changes as all configuration is done within your ApiTraffic account and pushed down to each connected server.
Learn more about redacting data.
Exclusions can be configured in cases where certain endpoints should not be logged. Like data redactions (above), no integration specific changes are required to exclude request that match a certain criteria.
Learn more about excluding requests.
- Sign in to ApiTraffic.
- Setup the SDK for your application.
npm i @apitraffic/koa --saveIMPORTANT: Node 18+ required.
const apiTraffic = require('@apitraffic/koa');
// register middlware...
app.use(apiTraffic());There are a two different methods for configuring the ApiTraffic SDK:
- Parameters passed into the
apiTraffic()function - Setting values as environment variables
These methods are not mutually exclusive, if for whatever reason you need to set some as parameters and some as environment variables, it is ok they can be mixed.
If the same variable is set in both places, the parameters that are passed in will always supersede the environment variables.
| Function Param | Environment Variable | Required | Type | Details |
|---|---|---|---|---|
| token | API_TRAFFIC_TOKEN | Yes | String | Ingest token provided from your ApiTraffic account. |
| bucket | API_TRAFFIC_BUCKET | Yes | String | The bucket the data should be sent to when ingested. |
| interceptOutbound | API_TRAFFIC_INTERCEPT_OUTBOUND | No | Boolean | If outbound requests should be intercepted. (Default: true) |
| debug | API_TRAFFIC_DEBUG | No | String | Flag that toggles if the debug output should be added to the console. (Default: true) |
Additional context can be added to requests via the tag() and trace() functions provided by the ApiTraffic SDK.
Tagging allows requests to be searchable by any number of tags that have been added to requests. For example, requests can be tagged by account or user ids which would then allow your team to view all API reqeusts for a specific account/person. There is no limit to the number of tags that can be added.
// include this in any file that needs tagging capabilities.
const apiTraffic = require('@apitraffic/koa');
// use the tag function.
apiTraffic.tag("key", "value");
It's console.log for production! Traces can easily be added to identify a specific code path or if data needs to be surfaced to help troubleshooting efforts.
// include this in any file that needs tracing capabilities.
const apiTraffic = require('@apitraffic/koa');
// use the trace function.
apiTraffic.trace("Whatever value that needs to be traced.");
A working sample has been provided in this repository. View the README for the sample application for details on how to run it.
To get started: Star & watch this repository to stay updated on the latest changes.
Follow us on our Blog and on X.
Chat with the ApiTraffic team and other memebers on Discord and follow our tutorials and other videos on YouTube.
Here are some ways you can help improve ApiTraffic:
- Give ApiTraffic a try and share your feedback to help make ApiTraffic even better for you. Feel free to reach out to us on Discord!
- Join our Discord to connect with other members, share your experiences, and learn from one another.
- Submit a pull request to any of our open source repositories. Be sure to review the contribution guide in the repository for detailed instructions on how to get started. We’re excited to see your contributions!