Skip to content
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

Adds constant_tags to ThreadStats #90

Merged
merged 2 commits into from
Oct 19, 2015
Merged

Adds constant_tags to ThreadStats #90

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a8e2f9d
Adds constant_tags to ThreadStats
johnistan Oct 14, 2015
c1a2432
adds contant tags to base datadog agent
johnistan Oct 18, 2015
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
24 changes: 22 additions & 2 deletions datadog/threadstats/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,16 @@

class ThreadStats(object):

def __init__(self):
""" Initialize a dogstats object. """
def __init__(self, constant_tags=None):
"""
Initialize a dogstats object.

:param constant_tags: Tags to attach to every metric reported by this client
:type constant_tags: list of strings
"""
# Don't collect until start is called.
self._disabled = True
self.constant_tags = constant_tags

def start(self, flush_interval=10, roll_up_interval=10, device=None,
flush_in_thread=True, flush_in_greenlet=False, disabled=False):
Expand Down Expand Up @@ -116,6 +122,13 @@ def event(self, title, text, alert_type=None, aggregation_key=None,
'The web server is up again', alert_type='success')
"""
if not self._disabled:
# Append all client level tags to every event
if self.constant_tags:
if tags:
tags += self.constant_tags
else:
tags = self.constant_tags

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

constant_tags are not associated to events in dogstatsd. To be consistent, we should do the same with ThreadStats, what do you think ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or I can add to dogstatsd. We have a use case for it.

On Fri, Oct 16, 2015, 9:12 AM Yann [email protected] wrote:

In datadog/threadstats/base.py
#90 (comment):

@@ -116,6 +122,13 @@ def event(self, title, text, alert_type=None, aggregation_key=None,
'The web server is up again', alert_type='success')
"""
if not self._disabled:

  •        # Append all client level tags to every event

  •        if self.constant_tags:

  •            if tags:

  •                tags += self.constant_tags

  •            else:

  •                tags = self.constant_tags

constant_tags are not associated to events in dogstatsd. To be
consistent, we should do the same with ThreadStats, what do you think ?

—
Reply to this email directly or view it on GitHub
https://github.com/DataDog/datadogpy/pull/90/files#r42253553.

self._event_aggregator.add_event(
title=title, text=text, alert_type=alert_type, aggregation_key=aggregation_key,
source_type_name=source_type_name, date_happened=date_happened, priority=priority,
Expand Down Expand Up @@ -292,6 +305,13 @@ def _get_aggregate_metrics(self, flush_time=None):
# FIXME: emit a dictionary from the aggregator
metrics = []
for timestamp, value, name, tags, host in rolled_up_metrics:
# Append all client level tags to every metric
if self.constant_tags:
if tags:
tags += self.constant_tags
else:
tags = self.constant_tags

metric = {
'metric': name,
'points': [[timestamp, value]],
Expand Down
82 changes: 81 additions & 1 deletion tests/unit/threadstats/test_threadstats.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,8 +103,9 @@ def test_event(self):
reporter.events = []
event1_priority = "low"
event1_date_happened = 1375296969
event1_tag = "Event 2 tag"
dog.event(event1_title, event1_text, priority=event1_priority,
date_happened=event1_date_happened)
date_happened=event1_date_happened, tags=[event1_tag])

# Flush and test
dog.flush()
Expand All @@ -113,6 +114,49 @@ def test_event(self):
nt.assert_equal(event['text'], event1_text)
nt.assert_equal(event['priority'], event1_priority)
nt.assert_equal(event['date_happened'], event1_date_happened)
nt.assert_equal(event['tags'], [event1_tag])

def test_event_constant_tags(self):
constant_tag = 'type:constant'
dog = ThreadStats(constant_tags=[constant_tag])
dog.start(roll_up_interval=10, flush_in_thread=False)
reporter = dog.reporter = MemoryReporter()

# Add two events
event1_title = "Event 1 title"
event2_title = "Event 1 title"
event1_text = "Event 1 text"
event2_text = "Event 2 text"
dog.event(event1_title, event1_text)
dog.event(event2_title, event2_text)

# Flush and test
dog.flush()
event1, event2 = reporter.events
nt.assert_equal(event1['title'], event1_title)
nt.assert_equal(event1['text'], event1_text)
nt.assert_equal(event1['tags'], [constant_tag])
nt.assert_equal(event2['title'], event2_title)
nt.assert_equal(event2['text'], event2_text)
nt.assert_equal(event2['text'], event2_text)
nt.assert_equal(event2['tags'], [constant_tag])

# Test more parameters
reporter.events = []
event1_priority = "low"
event1_date_happened = 1375296969
event1_tag = "Event 2 tag"
dog.event(event1_title, event1_text, priority=event1_priority,
date_happened=event1_date_happened, tags=[event1_tag])

# Flush and test
dog.flush()
event, = reporter.events
nt.assert_equal(event['title'], event1_title)
nt.assert_equal(event['text'], event1_text)
nt.assert_equal(event['priority'], event1_priority)
nt.assert_equal(event['date_happened'], event1_date_happened)
nt.assert_equal(event['tags'], [event1_tag, constant_tag])

def test_histogram(self):
dog = ThreadStats()
Expand Down Expand Up @@ -345,6 +389,42 @@ def test_tags(self):
nt.assert_equal(g3['tags'], ['env:staging'])
nt.assert_equal(g3['points'][0][1], 20)

def test_constant_tags(self):
dog = ThreadStats(constant_tags=['type:constant'])
dog.start(roll_up_interval=10, flush_in_thread=False)
reporter = dog.reporter = MemoryReporter()

# Post the same metric with different tags.
dog.gauge('gauge', 10, timestamp=100.0)
dog.gauge('gauge', 15, timestamp=100.0, tags=['env:production', 'db'])
dog.gauge('gauge', 20, timestamp=100.0, tags=['env:staging'])

dog.increment('counter', timestamp=100.0)
dog.increment('counter', timestamp=100.0, tags=['env:production', 'db'])
dog.increment('counter', timestamp=100.0, tags=['env:staging'])

dog.flush(200.0)

metrics = self.sort_metrics(reporter.metrics)
nt.assert_equal(len(metrics), 6)

[c1, c2, c3, g1, g2, g3] = metrics
(nt.assert_equal(c['metric'], 'counter') for c in [c1, c2, c3])
nt.assert_equal(c1['tags'], ['env:production', 'db', 'type:constant'])
nt.assert_equal(c1['points'][0][1], 1)
nt.assert_equal(c2['tags'], ['env:staging', 'type:constant'])
nt.assert_equal(c2['points'][0][1], 1)
nt.assert_equal(c3['tags'], ['type:constant'])
nt.assert_equal(c3['points'][0][1], 1)

(nt.assert_equal(c['metric'], 'gauge') for c in [g1, g2, g3])
nt.assert_equal(g1['tags'], ['env:production', 'db', 'type:constant'])
nt.assert_equal(g1['points'][0][1], 15)
nt.assert_equal(g2['tags'], ['env:staging', 'type:constant'])
nt.assert_equal(g2['points'][0][1], 20)
nt.assert_equal(g3['tags'], ['type:constant'])
nt.assert_equal(g3['points'][0][1], 10)

# Ensure histograms work as well.
@dog.timed('timed', tags=['version:1'])
def test():
Expand Down