Skip to content

Commit

Permalink
Move debug controller
Browse files Browse the repository at this point in the history
  • Loading branch information
ocelotl committed Oct 28, 2020
1 parent f60b041 commit ea79a25
Show file tree
Hide file tree
Showing 2 changed files with 62 additions and 44 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@
# limitations under the License.

import threading
from time import sleep

from opentelemetry.context import attach, detach, set_value
from opentelemetry.metrics import Meter
Expand Down Expand Up @@ -62,46 +61,3 @@ def tick(self):
detach(token)
# Perform post-exporting logic
self.meter.processor.finished_collection()


class DebugController:
"""A debug controller, used to replace Push controller when debugging
Push controller uses a thread which makes it hard to use the IPython
debugger. This controller does not use a thread, but relies on the user
manually calling its ``run`` method to start the controller.
Args:
meter: The meter used to collect metrics.
exporter: The exporter used to export metrics.
interval: The collect/export interval in seconds.
"""

daemon = True

def __init__(
self, meter: Meter, exporter: MetricsExporter, interval: float
):
super().__init__()
self.meter = meter
self.exporter = exporter
self.interval = interval

def run(self):
while True:
self.tick()
sleep(self.interval)

def shutdown(self):
# Run one more collection pass to flush metrics batched in the meter
self.tick()

def tick(self):
# Collect all of the meter's metrics to be exported
self.meter.collect()
# Export the collected metrics
token = attach(set_value("suppress_instrumentation", True))
self.exporter.export(self.meter.processor.checkpoint_set())
detach(token)
# Perform post-exporting logic
self.meter.processor.finished_collection()
62 changes: 62 additions & 0 deletions tests/util/src/opentelemetry/test/controller.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
# Copyright The OpenTelemetry Authors
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

from time import sleep

from opentelemetry.context import attach, detach, set_value
from opentelemetry.metrics import Meter
from opentelemetry.sdk.metrics.export import MetricsExporter


class DebugController:
"""A debug controller, used to replace Push controller when debugging
Push controller uses a thread which makes it hard to use the IPython
debugger. This controller does not use a thread, but relies on the user
manually calling its ``run`` method to start the controller.
Args:
meter: The meter used to collect metrics.
exporter: The exporter used to export metrics.
interval: The collect/export interval in seconds.
"""

daemon = True

def __init__(
self, meter: Meter, exporter: MetricsExporter, interval: float
):
super().__init__()
self.meter = meter
self.exporter = exporter
self.interval = interval

def run(self):
while True:
self.tick()
sleep(self.interval)

def shutdown(self):
# Run one more collection pass to flush metrics batched in the meter
self.tick()

def tick(self):
# Collect all of the meter's metrics to be exported
self.meter.collect()
# Export the collected metrics
token = attach(set_value("suppress_instrumentation", True))
self.exporter.export(self.meter.processor.checkpoint_set())
detach(token)
# Perform post-exporting logic
self.meter.processor.finished_collection()

0 comments on commit ea79a25

Please sign in to comment.