Skip to main content

upload-mcu-symbols

Description

Upload symbols for an MCU build.

Memfault will use the Build Id in the symbol file to identify it and match
it with data sent by that build. See https://mflt.io/symbol-file-build-ids
for more information on enabling Build Id in your project.

In case a Build Id cannot be found in the symbol file, a `--software-type`
and `--software-version` must be passed. This will then be used as
identifying information instead of a Build Id.

Even if a Build Id is available, it is possible to pass a `--software-type`
and `--software-version`. This will link the symbol file with the specified
Software Version, which can be useful to easily retrieve the symbol file by
Software Version through the Memfault UI.


Example MCU Symbols Upload:

$ memfault --org-token $ORG_TOKEN \
--org acme-inc --project smart-sink \
upload-mcu-symbols \
build/symbols.elf


Example MCU Symbols Upload, associating it with a Software Version:

$ memfault --org-token $ORG_TOKEN \
--org acme-inc --project smart-sink \
upload-mcu-symbols \
--software-type stm32-fw \
--software-version 1.0.0-alpha \
--revision 89335ffade90ff7697e2ce5238bd4c68978b6d6e \
build/symbols.elf

Arguments

ArgumentTypeRequired
pathPathTrue

Options

OptionShortRequiredDefaultDescription
--software-typeNoneFalseNone

Required for MCU symbols without Build Id, see https://mflt.io/symbol-file-build-ids

--software-versionNoneFalseNone

Required for MCU symbols without Build Id, see https://mflt.io/symbol-file-build-ids

--check-uploadedNoneFalseTrue

Control whether to check for an existing symbol file before uploading

--revisionNoneFalseNone

Revision SHA or # (git, SVN, etc.)

--helpNoneFalseFalse

Show this message and exit.