We’re pleased to announce that custom Hypernode Insights annotations are now available through the Hypernode API, and hypernode/deploy 4.9.0 together with hypernode/deploy-configuration 3.8.1 can now create them automatically after a successful deployment.
This makes it easier to correlate deploys, maintenance actions, and other operational changes with what you see in your Insights graphs.
When you’re investigating a spike in response time, a drop in cache hit rate, or an increase in memory usage, timing matters. Usually, the first question is simple: what changed around that moment? Custom annotations help answer that question directly in the graph, without having to cross-reference a deployment log, CI pipeline, or a separate incident timeline.
That means you can mark releases, maintenance windows, cache resets, feature rollouts, or one-off debugging actions right where they matter most, next to the metrics you are already looking at.
What’s new
- You can now create your own Insights annotations through the Hypernode API.
- You can list custom annotations that were created through the API.
- Hypernode Deploy now includes an after-deploy task that can push an annotation automatically after each successful release.
This is especially useful when you want to answer questions like: “Did this latency spike start before or after our deploy?” or “Did this release affect memory usage, PHP workers, or cache hit rates?”
In practice, that can save time during incident response and make routine performance checks much more straightforward. Instead of reconstructing a timeline manually, you can see the operational event and the graph behavior together.
Create Annotations via the API
We have added two new API endpoints:
GET /v2/insights-annotation/POST /v2/insights-annotation/create/
The create endpoint lets you submit a custom annotation with fields such as `name`, `x_axis`, `app`, `metrics`, and `metadata`.
If you omit `metrics`, the annotation applies to all metrics.
This gives you a flexible way to record events from your own tooling as well. For example, you could create annotations from a CI pipeline, a deployment script, or an internal maintenance job, depending on what you want to track over time.
Included in Hypernode Deploy
Hypernode Deploy 4.9.0 now supports pushing a custom Insights annotation automatically after a successful deploy. This support is configured through hypernode/deploy-configuration 3.8.1.
By default, the annotation uses the release name as name and Hypernode Deploy as the description. Hypernode Deploy will also try to detect the app name and API token automatically. If needed, you can override these values in your deploy configuration.
This means deploys can now leave a visible marker in Insights without any extra manual step. Once configured, each successful release can show up on the timeline automatically, which makes it much easier to compare code changes against the behavior of your application and platform metrics.
For example, you can add an after-deploy task like this in your deploy.php:
$configuration->addAfterDeployTask(
new \Hypernode\DeployConfiguration\AfterDeployTask\HypernodeAnnotation(
name: 'Production deploy',
description: 'Release deployed through Hypernode Deploy'
)
);
You can find more details here:
Let us know if you run into any issues or have questions via our support channels.