raphael
6c6dc84c22
README §3 promised a monitoring story ("aggregate into Prometheus via
a sidecar that polls the data model"). Nothing shipped. Customers
running a real fab without a metrics pipeline find out about T7
storms, spool blowups, and stalled CJs after their MES does — not
the position you want SRE in.
This commit ships:
- include/secsgem/metrics/prometheus.hpp: header-only. A Registry
(counters + gauges + HELP/TYPE descriptions, label-keyed,
mutex-guarded so updates from the io thread and scrape renders from
the same io serialize cleanly) plus a PrometheusServer (asio
acceptor, replies to any GET with the text-exposition rendering,
no auth — drop nginx in front for that).
- tests/test_metrics_prometheus.cpp: 3 cases / 19 assertions.
Render counter+gauge with labels, scrape via raw TCP and parse the
HTTP body, verify live updates land on subsequent scrapes.
- INTEGRATION.md §6.4: worked example that pairs the exporter with the
Connection + EquipmentDataModel hooks documented in §6.1/§6.2.
Shows the wrap-around-handler trick for message counters, a 5s
polling timer for gauges (spool depth, active alarms), and the
expected /metrics output.
Deliberately *not* shipped:
- A StandardMetrics helper that auto-wires everything — would force
a single hook owner per store, breaking customers who want
composable observers. Customers wire what they need; the registry
gives them counters + gauges + an HTTP endpoint, no policy.
- TLS / auth on the HTTP endpoint. Reverse-proxy territory.
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
156 lines
4.8 KiB
CMake
156 lines
4.8 KiB
CMake
cmake_minimum_required(VERSION 3.20)
|
|
project(secsgem LANGUAGES CXX)
|
|
|
|
set(CMAKE_CXX_STANDARD 20)
|
|
set(CMAKE_CXX_STANDARD_REQUIRED ON)
|
|
set(CMAKE_CXX_EXTENSIONS OFF)
|
|
|
|
if(NOT CMAKE_BUILD_TYPE)
|
|
set(CMAKE_BUILD_TYPE Release)
|
|
endif()
|
|
|
|
add_compile_options(-Wall -Wextra -Wpedantic)
|
|
|
|
find_package(Threads REQUIRED)
|
|
find_package(yaml-cpp REQUIRED)
|
|
|
|
# --- Asio (standalone, header-only; from libasio-dev) ---------------------
|
|
find_path(ASIO_INCLUDE_DIR asio.hpp)
|
|
if(NOT ASIO_INCLUDE_DIR)
|
|
message(FATAL_ERROR "asio.hpp not found. Install libasio-dev.")
|
|
endif()
|
|
|
|
add_library(asio INTERFACE)
|
|
target_include_directories(asio INTERFACE ${ASIO_INCLUDE_DIR})
|
|
target_compile_definitions(asio INTERFACE ASIO_STANDALONE ASIO_NO_DEPRECATED)
|
|
target_link_libraries(asio INTERFACE Threads::Threads)
|
|
|
|
# --- Core library ---------------------------------------------------------
|
|
# --- Codegen: SECS-II message catalog -> messages.hpp ---------------------
|
|
set(MESSAGES_HPP ${CMAKE_BINARY_DIR}/generated/secsgem/gem/messages.hpp)
|
|
add_custom_command(
|
|
OUTPUT ${MESSAGES_HPP}
|
|
COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_BINARY_DIR}/generated/secsgem/gem
|
|
COMMAND python3 ${CMAKE_SOURCE_DIR}/tools/gen_messages.py
|
|
--catalog ${CMAKE_SOURCE_DIR}/data/messages.yaml
|
|
--out ${MESSAGES_HPP}
|
|
DEPENDS ${CMAKE_SOURCE_DIR}/tools/gen_messages.py
|
|
${CMAKE_SOURCE_DIR}/data/messages.yaml
|
|
COMMENT "Generating SECS-II messages.hpp from data/messages.yaml"
|
|
VERBATIM
|
|
)
|
|
add_custom_target(generate_messages DEPENDS ${MESSAGES_HPP})
|
|
|
|
add_library(secsgem
|
|
src/secs2/codec.cpp
|
|
src/secs2/sml.cpp
|
|
src/hsms/header.cpp
|
|
src/hsms/connection.cpp
|
|
src/secsi/header.cpp
|
|
src/secsi/block.cpp
|
|
src/secsi/protocol.cpp
|
|
src/secsi/tcp_transport.cpp
|
|
src/gem/control_state.cpp
|
|
src/gem/communication_state.cpp
|
|
src/gem/process_job_state.cpp
|
|
src/gem/control_job_state.cpp
|
|
src/gem/exception_state.cpp
|
|
src/gem/carrier_state.cpp
|
|
src/gem/load_port_state.cpp
|
|
src/gem/substrate_state.cpp
|
|
src/gem/ept_state.cpp
|
|
src/gem/cem_objects.cpp
|
|
src/gem/module_state.cpp
|
|
src/gem/e84_state.cpp
|
|
src/gem/host_handler.cpp
|
|
src/config/loader.cpp
|
|
src/config/validate.cpp
|
|
src/endpoint.cpp
|
|
)
|
|
add_dependencies(secsgem generate_messages)
|
|
target_include_directories(secsgem PUBLIC
|
|
include
|
|
${CMAKE_BINARY_DIR}/generated
|
|
)
|
|
target_link_libraries(secsgem PUBLIC asio yaml-cpp)
|
|
|
|
# --- Demo executables -----------------------------------------------------
|
|
add_executable(secs_server apps/secs_server.cpp)
|
|
target_link_libraries(secs_server PRIVATE secsgem)
|
|
|
|
add_executable(secs_client apps/secs_client.cpp)
|
|
target_link_libraries(secs_client PRIVATE secsgem)
|
|
|
|
add_executable(secs_interop_probe apps/secs_interop_probe.cpp)
|
|
target_link_libraries(secs_interop_probe PRIVATE secsgem)
|
|
|
|
add_executable(secs_conformance apps/secs_conformance.cpp)
|
|
target_link_libraries(secs_conformance PRIVATE secsgem)
|
|
|
|
add_executable(secs_bench apps/secs_bench.cpp)
|
|
target_link_libraries(secs_bench PRIVATE secsgem)
|
|
|
|
# --- Tests ----------------------------------------------------------------
|
|
enable_testing()
|
|
include(FetchContent)
|
|
FetchContent_Declare(
|
|
doctest
|
|
GIT_REPOSITORY https://github.com/doctest/doctest.git
|
|
GIT_TAG v2.4.11
|
|
)
|
|
FetchContent_MakeAvailable(doctest)
|
|
|
|
add_executable(secsgem_tests
|
|
tests/test_main.cpp
|
|
tests/test_secs2.cpp
|
|
tests/test_fuzz.cpp
|
|
tests/test_hsms.cpp
|
|
tests/test_hsms_connection.cpp
|
|
tests/test_hsms_timers.cpp
|
|
tests/test_hsms_s9.cpp
|
|
tests/test_hsms_gs.cpp
|
|
tests/test_secsi.cpp
|
|
tests/test_secsi_timers.cpp
|
|
tests/test_secsi_tcp.cpp
|
|
tests/test_host_handler.cpp
|
|
tests/test_control_state.cpp
|
|
tests/test_communication_state.cpp
|
|
tests/test_data_model.cpp
|
|
tests/test_messages.cpp
|
|
tests/test_loader.cpp
|
|
tests/test_process_jobs.cpp
|
|
tests/test_control_jobs.cpp
|
|
tests/test_job_persistence.cpp
|
|
tests/test_exceptions.cpp
|
|
tests/test_exception_persistence.cpp
|
|
tests/test_carrier_state.cpp
|
|
tests/test_carriers.cpp
|
|
tests/test_carrier_persistence.cpp
|
|
tests/test_substrates.cpp
|
|
tests/test_substrate_persistence.cpp
|
|
tests/test_ept.cpp
|
|
tests/test_cem_objects.cpp
|
|
tests/test_modules.cpp
|
|
tests/test_sml.cpp
|
|
tests/test_s9_fallback.cpp
|
|
tests/test_e84.cpp
|
|
tests/test_e84_ports.cpp
|
|
tests/test_e84_timers.cpp
|
|
tests/test_e84_asio_timers.cpp
|
|
tests/test_e42_formatted_pp.cpp
|
|
tests/test_gem300_scenario.cpp
|
|
tests/test_wire_ceid_emission.cpp
|
|
tests/test_live_gem300.cpp
|
|
tests/test_e87_wire_scenarios.cpp
|
|
tests/test_identifier_wildcards.cpp
|
|
tests/test_concurrency.cpp
|
|
tests/test_thread_safety.cpp
|
|
tests/test_persistence_upgrade.cpp
|
|
tests/test_config_validate.cpp
|
|
tests/test_metrics_prometheus.cpp
|
|
)
|
|
target_link_libraries(secsgem_tests PRIVATE secsgem doctest::doctest)
|
|
target_compile_definitions(secsgem_tests PRIVATE
|
|
SECSGEM_DATA_DIR="${CMAKE_SOURCE_DIR}/data")
|
|
add_test(NAME secsgem_tests COMMAND secsgem_tests)
|