What does the Heartbeat app do?
The Heartbeat app simply sends one event to your project every minute for as long as it is enabled. It's mainly useful for testing and works well in conjunction with the Ingestion Alert app.
What are the requirements for this app?
The Heartbeat app doesn't require a living heart, but it does require either PostHog Cloud, or a self-hosted PostHog instance running version 1.30.0 or later.
Not running 1.30.0? Find out how to update your self-hosted PostHog deployment!
How do I install the Heartbeat app?
- Log in to your PostHog instance
- Click 'Apps' on the left-hand tool bar
- Search for 'Heartbeat' press 'Install'
- Configure the by app by following the instructions below.
Configuration
| Option | Description |
|---|---|
Events to be emittedType: choice Required: True | The basic heartbeat event emitted by this plugin goes straight into the event ingestion queue. The heartbeat_buffer is emitted the same way as heartbeat, but has a different distinct ID each time to ensure it goes via the event buffer. The heartbeat_api event goes via the event capture endpoint, which helps monitor the API too. |
PostHog host with protocol (only for `heartbeat_api`)Type: string Required: False | |
PostHog project API key (only for `heartbeat_api`)Type: string Required: False |
Is the source code for this app available?
PostHog is open-source and so are all apps on the platform. The source code for the Heartbeat app is available on GitHub.
Who created this app?
We'd like to thank Marcus Hyett for creating the Heartbeat app. Thanks, Marcus!
Who maintains this app?
This app is maintained by PostHog. If you have issues with the app not functioning as intended, please raise a bug report to let us know!
What if I have feedback on this app?
We love feature requests and feedback! Please create an issue to tell us what you think.
What if my question isn't answered above?
We love answering questions. Ask us anything via our Support page.
You can also join the PostHog Community Slack group to collaborate with others and get advice on developing your own PostHog apps.