Skip to content

feat: Add per-machine consumption metrics and recipe label #35

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AP-Hunt merged 3 commits into from
Aug 18, 2026
Merged

feat: Add per-machine consumption metrics and recipe label #35

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9b304cc
feat: add per-machine item consumption metrics
jwalker343 Aug 18, 2026
69a68ea
test: cover new consumption metrics
jwalker343 Aug 18, 2026
363bd4f
docs: document new metrics and recipe label
jwalker343 Aug 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions Companion/exporter/factory_building_collector.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@ func NewFactoryBuildingCollector(endpoint string) *FactoryBuildingCollector {
metricsDropper: NewMetricsDropper(
MachineItemsProducedPerMin,
MachineItemsProducedEffiency,
MachineItemsConsumedPerMin,
MachineItemsConsumedEffiency,
MachineItemsConsumedMax,
),
}
}
Expand All @@ -39,6 +42,7 @@ func (c *FactoryBuildingCollector) Collect(frmAddress string, sessionName string
MachineItemsProducedPerMin.WithLabelValues(
prod.Name,
building.Building,
building.Recipe,
strconv.FormatFloat(building.Location.X, 'f', -1, 64),
strconv.FormatFloat(building.Location.Y, 'f', -1, 64),
strconv.FormatFloat(building.Location.Z, 'f', -1, 64),
Expand All @@ -48,6 +52,7 @@ func (c *FactoryBuildingCollector) Collect(frmAddress string, sessionName string
MachineItemsProducedEffiency.WithLabelValues(
prod.Name,
building.Building,
building.Recipe,
strconv.FormatFloat(building.Location.X, 'f', -1, 64),
strconv.FormatFloat(building.Location.Y, 'f', -1, 64),
strconv.FormatFloat(building.Location.Z, 'f', -1, 64),
Expand All @@ -57,13 +62,46 @@ func (c *FactoryBuildingCollector) Collect(frmAddress string, sessionName string
MachineItemsProducedMax.WithLabelValues(
prod.Name,
building.Building,
building.Recipe,
strconv.FormatFloat(building.Location.X, 'f', -1, 64),
strconv.FormatFloat(building.Location.Y, 'f', -1, 64),
strconv.FormatFloat(building.Location.Z, 'f', -1, 64),
frmAddress, sessionName,
).Set(prod.MaxProd)
}

for _, ing := range building.Ingredients {
MachineItemsConsumedPerMin.WithLabelValues(
ing.Name,
building.Building,
building.Recipe,
strconv.FormatFloat(building.Location.X, 'f', -1, 64),
strconv.FormatFloat(building.Location.Y, 'f', -1, 64),
strconv.FormatFloat(building.Location.Z, 'f', -1, 64),
frmAddress, sessionName,
).Set(ing.CurrentConsumed)

MachineItemsConsumedEffiency.WithLabelValues(
ing.Name,
building.Building,
building.Recipe,
strconv.FormatFloat(building.Location.X, 'f', -1, 64),
strconv.FormatFloat(building.Location.Y, 'f', -1, 64),
strconv.FormatFloat(building.Location.Z, 'f', -1, 64),
frmAddress, sessionName,
).Set(ing.ConsPercent)

MachineItemsConsumedMax.WithLabelValues(
ing.Name,
building.Building,
building.Recipe,
strconv.FormatFloat(building.Location.X, 'f', -1, 64),
strconv.FormatFloat(building.Location.Y, 'f', -1, 64),
strconv.FormatFloat(building.Location.Z, 'f', -1, 64),
frmAddress, sessionName,
).Set(ing.MaxConsumed)
}

for _, item := range building.InputInventory {
MachineInputInventory.WithLabelValues(
item.Name,
Expand Down
123 changes: 111 additions & 12 deletions Companion/exporter/factory_building_collector_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,12 @@ var _ = Describe("FactoryBuildingCollector", func() {
MaxConsumed: 5.0,
ConsPercent: 1.0,
},
{
Name: "Second ingredient",
CurrentConsumed: 2.0,
MaxConsumed: 8.0,
ConsPercent: 0.25,
},
},
ManuSpeed: 100.0,
IsConfigured: false,
Expand Down Expand Up @@ -108,15 +114,15 @@ var _ = Describe("FactoryBuildingCollector", func() {
Describe("Machine item production metrics", func() {
It("records a metric with labels for the produced item name, machine type, and x, y, z coordinates", func() {
collector.Collect(url, sessionName)
metric, err := getMetric(exporter.MachineItemsProducedPerMin, "Iron Ingot", "Smelter", "100", "200", "-300", url, sessionName)
metric, err := getMetric(exporter.MachineItemsProducedPerMin, "Iron Ingot", "Smelter", "Iron Ingot", "100", "200", "-300", url, sessionName)
Expect(err).ToNot(HaveOccurred())
Expect(metric).ToNot(BeNil())
})

It("records the current production figure as the metric value", func() {
collector.Collect(url, sessionName)

val, err := gaugeValue(exporter.MachineItemsProducedPerMin, "Iron Ingot", "Smelter", "100", "200", "-300", url, sessionName)
val, err := gaugeValue(exporter.MachineItemsProducedPerMin, "Iron Ingot", "Smelter", "Iron Ingot", "100", "200", "-300", url, sessionName)
Expect(err).ToNot(HaveOccurred())
Expect(val).To(Equal(float64(10.0)))
})
Expand All @@ -125,11 +131,11 @@ var _ = Describe("FactoryBuildingCollector", func() {
It("records a metric per item", func() {
collector.Collect(url, sessionName)

ironIngots, err := gaugeValue(exporter.MachineItemsProducedPerMin, "Iron Ingot", "Smelter", "100", "200", "-300", url, sessionName)
ironIngots, err := gaugeValue(exporter.MachineItemsProducedPerMin, "Iron Ingot", "Smelter", "Iron Ingot", "100", "200", "-300", url, sessionName)
Expect(err).ToNot(HaveOccurred())
Expect(ironIngots).To(Equal(float64(10.0)))

ironNothing, err := gaugeValue(exporter.MachineItemsProducedPerMin, "Iron Nothing", "Smelter", "100", "200", "-300", url, sessionName)
ironNothing, err := gaugeValue(exporter.MachineItemsProducedPerMin, "Iron Nothing", "Smelter", "Iron Ingot", "100", "200", "-300", url, sessionName)
Expect(err).ToNot(HaveOccurred())
Expect(ironNothing).To(Equal(float64(1000.0)))
})
Expand All @@ -139,15 +145,15 @@ var _ = Describe("FactoryBuildingCollector", func() {
Describe("Machine item max production metrics", func() {
It("records a metric with labels for the produced item name, machine type, and x, y, z coordinates", func() {
collector.Collect(url, sessionName)
metric, err := getMetric(exporter.MachineItemsProducedMax, "Iron Ingot", "Smelter", "100", "200", "-300", url, sessionName)
metric, err := getMetric(exporter.MachineItemsProducedMax, "Iron Ingot", "Smelter", "Iron Ingot", "100", "200", "-300", url, sessionName)
Expect(err).ToNot(HaveOccurred())
Expect(metric).ToNot(BeNil())
})

It("records the current max production as the metric value", func() {
collector.Collect(url, sessionName)

val, err := gaugeValue(exporter.MachineItemsProducedMax, "Iron Ingot", "Smelter", "100", "200", "-300", url, sessionName)
val, err := gaugeValue(exporter.MachineItemsProducedMax, "Iron Ingot", "Smelter", "Iron Ingot", "100", "200", "-300", url, sessionName)
Expect(err).ToNot(HaveOccurred())
Expect(val).To(Equal(float64(10)))
})
Expand All @@ -156,17 +162,110 @@ var _ = Describe("FactoryBuildingCollector", func() {
It("records a metric per item", func() {
collector.Collect(url, sessionName)

ironIngots, err := gaugeValue(exporter.MachineItemsProducedMax, "Iron Ingot", "Smelter", "100", "200", "-300", url, sessionName)
ironIngots, err := gaugeValue(exporter.MachineItemsProducedMax, "Iron Ingot", "Smelter", "Iron Ingot", "100", "200", "-300", url, sessionName)
Expect(err).ToNot(HaveOccurred())
Expect(ironIngots).To(Equal(float64(10.0)))

ironNothing, err := gaugeValue(exporter.MachineItemsProducedMax, "Iron Nothing", "Smelter", "100", "200", "-300", url, sessionName)
ironNothing, err := gaugeValue(exporter.MachineItemsProducedMax, "Iron Nothing", "Smelter", "Iron Ingot", "100", "200", "-300", url, sessionName)
Expect(err).ToNot(HaveOccurred())
Expect(ironNothing).To(Equal(float64(4000.0)))
})
})
})

Describe("Machine item consumption metrics", func() {
It("records a metric with labels for the consumed item name, machine type, recipe, and x, y, z coordinates", func() {
collector.Collect(url, sessionName)
metric, err := getMetric(exporter.MachineItemsConsumedPerMin, "Iron Ore", "Smelter", "Iron Ingot", "100", "200", "-300", url, sessionName)
Expect(err).ToNot(HaveOccurred())
Expect(metric).ToNot(BeNil())
})

It("records the current consumption figure as the metric value", func() {
collector.Collect(url, sessionName)

val, err := gaugeValue(exporter.MachineItemsConsumedPerMin, "Iron Ore", "Smelter", "Iron Ingot", "100", "200", "-300", url, sessionName)
Expect(err).ToNot(HaveOccurred())
Expect(val).To(Equal(float64(5.0)))
})

Describe("when a machine has multiple ingredients", func() {
It("records a metric per item", func() {
collector.Collect(url, sessionName)

ironOre, err := gaugeValue(exporter.MachineItemsConsumedPerMin, "Iron Ore", "Smelter", "Iron Ingot", "100", "200", "-300", url, sessionName)
Expect(err).ToNot(HaveOccurred())
Expect(ironOre).To(Equal(float64(5.0)))

secondIngredient, err := gaugeValue(exporter.MachineItemsConsumedPerMin, "Second ingredient", "Smelter", "Iron Ingot", "100", "200", "-300", url, sessionName)
Expect(err).ToNot(HaveOccurred())
Expect(secondIngredient).To(Equal(float64(2.0)))
})
})
})

Describe("Machine item max consumption metrics", func() {
It("records a metric with labels for the consumed item name, machine type, recipe, and x, y, z coordinates", func() {
collector.Collect(url, sessionName)
metric, err := getMetric(exporter.MachineItemsConsumedMax, "Iron Ore", "Smelter", "Iron Ingot", "100", "200", "-300", url, sessionName)
Expect(err).ToNot(HaveOccurred())
Expect(metric).ToNot(BeNil())
})

It("records the max consumption as the metric value", func() {
collector.Collect(url, sessionName)

val, err := gaugeValue(exporter.MachineItemsConsumedMax, "Iron Ore", "Smelter", "Iron Ingot", "100", "200", "-300", url, sessionName)
Expect(err).ToNot(HaveOccurred())
Expect(val).To(Equal(float64(5.0)))
})

Describe("when a machine has multiple ingredients", func() {
It("records a metric per item", func() {
collector.Collect(url, sessionName)

ironOre, err := gaugeValue(exporter.MachineItemsConsumedMax, "Iron Ore", "Smelter", "Iron Ingot", "100", "200", "-300", url, sessionName)
Expect(err).ToNot(HaveOccurred())
Expect(ironOre).To(Equal(float64(5.0)))

secondIngredient, err := gaugeValue(exporter.MachineItemsConsumedMax, "Second ingredient", "Smelter", "Iron Ingot", "100", "200", "-300", url, sessionName)
Expect(err).ToNot(HaveOccurred())
Expect(secondIngredient).To(Equal(float64(8.0)))
})
})
})

Describe("Machine item consumption efficiency metrics", func() {
It("records a metric with labels for the consumed item name, machine type, recipe, and x, y, z coordinates", func() {
collector.Collect(url, sessionName)
metric, err := getMetric(exporter.MachineItemsConsumedEffiency, "Iron Ore", "Smelter", "Iron Ingot", "100", "200", "-300", url, sessionName)
Expect(err).ToNot(HaveOccurred())
Expect(metric).ToNot(BeNil())
})

It("records the current consumption efficiency as the metric value", func() {
collector.Collect(url, sessionName)

val, err := gaugeValue(exporter.MachineItemsConsumedEffiency, "Iron Ore", "Smelter", "Iron Ingot", "100", "200", "-300", url, sessionName)
Expect(err).ToNot(HaveOccurred())
Expect(val).To(Equal(float64(1.0)))
})

Describe("when a machine has multiple ingredients", func() {
It("records a metric per item", func() {
collector.Collect(url, sessionName)

ironOre, err := gaugeValue(exporter.MachineItemsConsumedEffiency, "Iron Ore", "Smelter", "Iron Ingot", "100", "200", "-300", url, sessionName)
Expect(err).ToNot(HaveOccurred())
Expect(ironOre).To(Equal(float64(1.0)))

secondIngredient, err := gaugeValue(exporter.MachineItemsConsumedEffiency, "Second ingredient", "Smelter", "Iron Ingot", "100", "200", "-300", url, sessionName)
Expect(err).ToNot(HaveOccurred())
Expect(secondIngredient).To(Equal(float64(0.25)))
})
})
})

Describe("Machine input inventory metrics", func() {
It("records a metric with labels for the stored item name, machine type, and x, y, z coordinates", func() {
collector.Collect(url, sessionName)
Expand Down Expand Up @@ -294,15 +393,15 @@ var _ = Describe("FactoryBuildingCollector", func() {
Describe("Machine item production efficiency metrics", func() {
It("records a metric with labels for the produced item name, machine type, and x, y, z coordinates", func() {
collector.Collect(url, sessionName)
metric, err := getMetric(exporter.MachineItemsProducedEffiency, "Iron Ingot", "Smelter", "100", "200", "-300", url, sessionName)
metric, err := getMetric(exporter.MachineItemsProducedEffiency, "Iron Ingot", "Smelter", "Iron Ingot", "100", "200", "-300", url, sessionName)
Expect(err).ToNot(HaveOccurred())
Expect(metric).ToNot(BeNil())
})

It("records the current production efficiency as the metric value", func() {
collector.Collect(url, sessionName)

val, err := gaugeValue(exporter.MachineItemsProducedEffiency, "Iron Ingot", "Smelter", "100", "200", "-300", url, sessionName)
val, err := gaugeValue(exporter.MachineItemsProducedEffiency, "Iron Ingot", "Smelter", "Iron Ingot", "100", "200", "-300", url, sessionName)
Expect(err).ToNot(HaveOccurred())
Expect(val).To(Equal(float64(0.5)))
})
Expand All @@ -311,11 +410,11 @@ var _ = Describe("FactoryBuildingCollector", func() {
It("records a metric per item", func() {
collector.Collect(url, sessionName)

ironIngots, err := gaugeValue(exporter.MachineItemsProducedEffiency, "Iron Ingot", "Smelter", "100", "200", "-300", url, sessionName)
ironIngots, err := gaugeValue(exporter.MachineItemsProducedEffiency, "Iron Ingot", "Smelter", "Iron Ingot", "100", "200", "-300", url, sessionName)
Expect(err).ToNot(HaveOccurred())
Expect(ironIngots).To(Equal(float64(0.5)))

ironNothing, err := gaugeValue(exporter.MachineItemsProducedEffiency, "Iron Nothing", "Smelter", "100", "200", "-300", url, sessionName)
ironNothing, err := gaugeValue(exporter.MachineItemsProducedEffiency, "Iron Nothing", "Smelter", "Iron Ingot", "100", "200", "-300", url, sessionName)
Expect(err).ToNot(HaveOccurred())
Expect(ironNothing).To(Equal(float64(0.25)))
})
Expand Down
39 changes: 39 additions & 0 deletions Companion/exporter/factory_building_metrics.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ var (
}, []string{
"item_name",
"machine_name",
"recipe",
"x",
"y",
"z",
Expand All @@ -22,6 +23,7 @@ var (
}, []string{
"item_name",
"machine_name",
"recipe",
"x",
"y",
"z",
Expand All @@ -33,6 +35,43 @@ var (
}, []string{
"item_name",
"machine_name",
"recipe",
"x",
"y",
"z",
})

MachineItemsConsumedPerMin = RegisterNewGaugeVec(prometheus.GaugeOpts{
Name: "machine_items_consumed_per_min",
Help: "How much of an item a building is consuming",
}, []string{
"item_name",
"machine_name",
"recipe",
"x",
"y",
"z",
})

MachineItemsConsumedEffiency = RegisterNewGaugeVec(prometheus.GaugeOpts{
Name: "machine_items_consumed_pc",
Help: "The efficiency with which a building is consuming an item",
}, []string{
"item_name",
"machine_name",
"recipe",
"x",
"y",
"z",
})

MachineItemsConsumedMax = RegisterNewGaugeVec(prometheus.GaugeOpts{
Name: "machine_items_consumed_max",
Help: "The maximum of a certain item which the machine can consume",
}, []string{
"item_name",
"machine_name",
"recipe",
"x",
"y",
"z",
Expand Down
21 changes: 18 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,17 +88,32 @@ The [Prometheus metrics server](https://prometheus.io/) allows you to [explore t
<tr>
<td>machine_items_produced_per_min</td>
<td>How much of an item a building is producing</td>
<td>item_name, machine_name, x, y, z, url, session_name</td>
<td>item_name, machine_name, recipe, x, y, z, url, session_name</td>
</tr>
<tr>
<td>machine_items_produced_pc</td>
<td>The efficiency with which a building is producing an item</td>
<td>item_name, machine_name, x, y, z, url, session_name</td>
<td>item_name, machine_name, recipe, x, y, z, url, session_name</td>
</tr>
<tr>
<td>machine_items_produced_max</td>
<td>Maximum production rate of an item a building can produce per minute</td>
<td>item_name, machine_name, x, y, z, url, session_name</td>
<td>item_name, machine_name, recipe, x, y, z, url, session_name</td>
</tr>
<tr>
<td>machine_items_consumed_per_min</td>
<td>How much of an item a building is consuming</td>
<td>item_name, machine_name, recipe, x, y, z, url, session_name</td>
</tr>
<tr>
<td>machine_items_consumed_pc</td>
<td>The efficiency with which a building is consuming an item</td>
<td>item_name, machine_name, recipe, x, y, z, url, session_name</td>
</tr>
<tr>
<td>machine_items_consumed_max</td>
<td>Maximum consumption rate of an item a building can consume per minute</td>
<td>item_name, machine_name, recipe, x, y, z, url, session_name</td>
</tr>
<tr>
<td>machine_input_inventory</td>
Expand Down
Loading