autoware_utils_debug

Overview

The autoware_utils library is a comprehensive toolkit designed to facilitate the development of autonomous driving applications. This package provides essential utilities for debug. It is extensively used in the Autoware project to handle common tasks such as publishing debug data and measuring time.

Design

• debug_publisher.hpp: A helper class for publishing debug messages with timestamps.
• debug_traits.hpp: Traits for identifying debug message types.
• processing_time_publisher.hpp: Publishes processing times as diagnostic messages.
• published_time_publisher.hpp: Tracks and publishes the time when messages are published.
• time_keeper.hpp: Tracks and reports the processing time of various functions.

Example Code Snippets

Handling Debug Message Types with debug_traits.hpp

#include <autoware_utils_debug/debug_publisher.hpp>
#include <autoware_utils_debug/debug_traits.hpp>
#include <rclcpp/rclcpp.hpp>

int main(int argc, char * argv[]) {
  rclcpp::init(argc, argv);
  auto node = rclcpp::Node::make_shared("debug_node");

  // Initialize DebugPublisher
  autoware_utils_debug::DebugPublisher debug_pub(node, "/debug");

  // Publish a debug message with custom type
  float debug_data = 42.0;
  debug_pub.publish<autoware_internal_debug_msgs::msg::Float32Stamped>("example", debug_data);

  rclcpp::shutdown();
  return 0;
}

Logging Processing Times with ProcessingTimePublisher

#include <autoware_utils_debug/processing_time_publisher.hpp>
#include <rclcpp/rclcpp.hpp>
#include <map>

int main(int argc, char * argv[]) {
  rclcpp::init(argc, argv);
  auto node = rclcpp::Node::make_shared("processing_time_node");

  // Initialize ProcessingTimePublisher
  autoware_utils_debug::ProcessingTimePublisher processing_time_pub(node.get(), "~/debug/processing_time_ms");

  // Simulate some processing times
  std::map<std::string, double> processing_times = {
    {"node1", 0.1}, {"node2", 0.2}, {"node3", 0.3}
  };

  // Publish processing times
  processing_time_pub.publish(processing_times);

  rclcpp::shutdown();
  return 0;
}

Changelog for package autoware_utils_debug

1.4.0 (2025-04-22)

• chore: sync files (#61)
  • chore: sync files

  * style(pre-commit): autofix ---------Co-authored-by: github-actions <<github-actions@github.com>> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]\@users.noreply.github.com>

• ci(pre-commit): quarterly autoupdate (#60) * ci(pre-commit): quarterly autoupdate updates:
  • [github.com/igorshubovych/markdownlint-cli: v0.43.0 → v0.44.0](https://github.com/igorshubovych/markdownlint-cli/compare/v0.43.0...v0.44.0)
  • [github.com/adrienverge/yamllint: v1.35.1 → v1.37.0](https://github.com/adrienverge/yamllint/compare/v1.35.1...v1.37.0)
  • [github.com/scop/pre-commit-shfmt: v3.10.0-2 → v3.11.0-1](https://github.com/scop/pre-commit-shfmt/compare/v3.10.0-2...v3.11.0-1)
  • [github.com/pycqa/isort: 5.13.2 → 6.0.1](https://github.com/pycqa/isort/compare/5.13.2...6.0.1)
  • [github.com/psf/black: 24.10.0 → 25.1.0](https://github.com/psf/black/compare/24.10.0...25.1.0)
  • [github.com/pre-commit/mirrors-clang-format: v19.1.6 → v20.1.0](https://github.com/pre-commit/mirrors-clang-format/compare/v19.1.6...v20.1.0)
  • [github.com/cpplint/cpplint: 2.0.0 → 2.0.1](https://github.com/cpplint/cpplint/compare/2.0.0...2.0.1)
  • [github.com/python-jsonschema/check-jsonschema: 0.30.0 → 0.32.1](https://github.com/python-jsonschema/check-jsonschema/compare/0.30.0...0.32.1)

  * style(pre-commit): autofix ---------Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]\@users.noreply.github.com>

• Contributors: awf-autoware-bot[bot], pre-commit-ci[bot]

1.3.0 (2025-03-21)

• unify version
• update changelog
• feat(autoware_utils_debug): split package (#44)
  • feat(autoware_utils_system): split package
  • update for compatibility
  • feat(autoware_utils_debug): split package
  • apply testing utils
  • feat(autoware_utils_testing): create test utils
  • update test
  • add mock node
  • add test
  • update readme
  • remove testing
  • compatibility

  * fix sample code namespace ---------

• Contributors: Takagi, Isamu, Yutaka Kondo
• feat(autoware_utils_debug): split package (#44)
  • feat(autoware_utils_system): split package
  • update for compatibility
  • feat(autoware_utils_debug): split package
  • apply testing utils
  • feat(autoware_utils_testing): create test utils
  • update test
  • add mock node
  • add test
  • update readme
  • remove testing
  • compatibility

  * fix sample code namespace ---------

• Contributors: Takagi, Isamu

1.2.0 (2025-02-26)

1.1.0 (2025-01-27)

1.0.0 (2024-05-02)