Project Keys (aka Data Routes)
Devices (or components) that talk to Memfault need to identify themselves through their serial number and a Project Key. The Project Keys tab in Project Settings shows a list of all the Project Keys for your current project. Using multiple project keys can have benefits as your project grows.
Use Cases
Key Rotation
Regularly changing (rotating) the project keys enables you to enhance security and prevent unauthorized access to your project, by limiting the time any one key is valid for your project. By rotating the keys, you can minimize the risk of any compromised keys being used maliciously.
When OTA is Enabled
If you’re using OTA, key rotation likely won’t be feasible for you as you’d exclude devices from ever receiving further updates. Please contact us for help in this scenario.
Routing Data to Specific Project
Uploading data to Memfault requires a Project Key. In complex deployments, the device uploading the data may not be the device which created it.
Whenever there is a difference, Memfault will assign the data to the project referenced by the Project Key inside the payload.
On Linux and Android, payloads always contain the project key defined in the SDK configuration. For MCU, no project key is included by default but you can provide one when required.
See the MCU FAQ entry for details.
Mixed Projects
Projects with Different Devices Types
If you plan to use a single project for multiple devices, strongly consider creating a different project key for each device type. While Memfault does not currently offer different settings per project key, multiple keys will set you up for future functionality we introduce that can be configured at a project key level.
Devices with Multiple MCUs or OSes
You may have devices that have multiple MCUs. In this scenario, having multiple project keys can help you differentiate and manage the data from each MCU separately. This allows for better organization and analysis of the data collected from each MCU.
Common Actions
Creating a New Project Key
- Navigate to project settings.
- Click on Create Project Key.
- Provide a description (optional).
- You’ll be presented with the new project key.
Editing an Existing Project Key
- Navigate to Project settings.
- Click on the pencil icon next to the description.
- Enter your new description.
- Click Save or hit Enter to save the description.
The only editable trait of a project key is its description.
Deactivating an Existing Project Key
Please contact us if you wish to deactivate a project key.