add support for trusted fact tags and add info line for puppetserver … #662

murdok5 · 2020-10-21T23:37:58Z

…log notifications

What does this PR do?

Resolve issue where trusted facts were not working for report fact tags.

Motivation

Customer request based on experience/need.

Additional Notes

Added an unrelated info line to the report processor to log successful sends to Datadog API

Describe your test plan

Tested in a lab environment using Puppet Enterprise 2019.8.1 with current Datadog.

…log notifications

murdok5 · 2020-10-21T23:38:24Z

@albertvaka resolved the issues for trusted facts.

albertvaka · 2020-10-22T11:50:03Z

Thanks a lot! We didn't know this was possible :) To be consistent with #658 I think we want to have a separate argument (eg: report_trusted_fact_tags) instead of merging the two hashes, but I will make that change on a separate PR. Your help is super appreciated 🙇

murdok5 · 2020-10-22T15:03:13Z

@albertvaka either merged or separate works makes sense. The reason I merged into a single hash was user simplicity and trusted is a reserved name so there is not a chance of duplication.

albertvaka · 2020-10-22T15:48:59Z

Yeah, I agree it's simpler like this, but since I initially added two separate arguments for facts_to_tags and trusted_facts_to_tags I think this should follow the same pattern with report_fact_tags and report_trusted_fact_tags.

murdok5 · 2020-10-22T15:59:28Z

Yeah, I agree it's simpler like this, but since I initially added two separate arguments for facts_to_tags and trusted_facts_to_tags I think this should follow the same pattern with report_fact_tags and report_trusted_fact_tags.

Makes sense to stay consistent with that pattern.

albertvaka · 2020-10-22T16:48:09Z

I pushed a commit to your branch that should do it, can you give it a quick look before I merge?

murdok5 · 2020-10-24T19:58:03Z

I pushed a commit to your branch that should do it, can you give it a quick look before I merge?

Were you able to test this or you do want me to test in my lab?

albertvaka · 2020-10-25T11:40:14Z

I've tested the Puppet side but not the Ruby script changes.

kayayarai

Hey there Mike! A couple typo fixes and some formatting to help with documentation readability, in the README.md.

kayayarai · 2020-11-05T19:41:50Z

README.md

@@ -152,7 +152,7 @@ To enable reporting of Puppet runs to your Datadog timeline, enable the report p

 5. (Optional) Enable tagging of reports with facts:

-    You can add tags to reports that are sent to Datadog as events. These tags can be sourced from Puppet facts for the given node the report is regarding. These should be 1:1 and not involve structured facts (hashes, arrays, etc.) to ensure readability. To enable tagging, set the parameter `datadog_agent::reports::report_fact_tags` to the array value of facts—for example `["virtual","trusted.extensions.pp_role","operatingsystem"]` results in three separate tags per report event.
+    You can add tags to reports that are sent to Datadog as events. These tags can be sourced from Puppet facts for the given node the report is regarding. These should be 1:1 and not involve structured facts (hashes, arrays, etc.) to ensure readability. To enable regular fact tagging, set the parameter `datadog_agent::reports::report_fact_tags` to the array value of facts—for example `["virtual","operatingsystem"]`. To enable trustd fact tagging, set the parameter `datadog_agent::reports::report_trusted_fact_tags` to the array value of facts—for example `["trusted.certname","trusted.extensions.pp_role","trusted hostname"]`.


Suggested change

You can add tags to reports that are sent to Datadog as events. These tags can be sourced from Puppet facts for the given node the report is regarding. These should be 1:1 and not involve structured facts (hashes, arrays, etc.) to ensure readability. To enable regular fact tagging, set the parameter `datadog_agent::reports::report_fact_tags` to the array value of facts—for example `["virtual","operatingsystem"]`. To enable trustd fact tagging, set the parameter `datadog_agent::reports::report_trusted_fact_tags` to the array value of facts—for example `["trusted.certname","trusted.extensions.pp_role","trusted hostname"]`.

You can add tags to reports that are sent to Datadog as events. These tags can be sourced from Puppet facts for the given node the report is regarding. These should be 1:1 and not involve structured facts (hashes, arrays, etc.) to ensure readability.

To enable regular fact tagging, set the parameter `datadog_agent::reports::report_fact_tags` to the array value of facts—for example `["virtual","operatingsystem"]`.

To enable trusted fact tagging, set the parameter `datadog_agent::reports::report_trusted_fact_tags` to the array value of facts—for example `["trusted.certname","trusted.extensions.pp_role","trusted.hostname"]`.

murdok5 · 2020-11-05T19:49:20Z

@kayayarai @albertvaka sorry for delay but I did some testing and confirmed functionality. I updated the readme and some debugging if needed as well. I tried to differentiate between tags for Datadog agents and Report (event) tagging.

README.md

Co-authored-by: Kari Halsted <[email protected]>

albertvaka · 2020-11-06T20:25:19Z

lib/puppet/reports/datadog_reports.rb

-    Puppet.debug "Sending events for #{@msg_host} to Datadog"
+    facts_tags = REPORT_FACT_TAGS.map { |name| "#{name}:#{facts.dig(*name.split('.'))}" }
+    trusted_facts = (Puppet.lookup(:trusted_information) { Hash.new }).to_h
+    trusted_facts = { "trusted" => trusted_facts.to_h }


To make sure report_trusted_fact_tags is consistent with trusted_facts_to_tags. When accessing the $trusted variable from puppet code, do you have to use the trusted.* prefix? (eg: $trusted['trusted. certname']). Since trusted_facts_to_tags just digs in $trusted.

From the examples section in Puppet docs [1], it looks like the trusted prefix doesn't have to be used when accessing $trusted, so I'm going to remove it from this PR and merge it.

[1] https://puppet.com/docs/puppet/5.5/lang_facts_and_builtin_vars.html#examples

kayayarai

👍 for the documentation

So report_trusted_fact_tags is consistent wih trusted_facts_to_tags

Disable Style/EmptyLiteral since it's way less readable to do { {} }

add support for trusted fact tags and add info line for puppetserver …

d3cea86

…log notifications

murdok5 requested a review from a team as a code owner October 21, 2020 23:37

albertvaka mentioned this pull request Oct 22, 2020

facts_to_tags, trusted_facts_to_tags, report_fact_tags and report_trusted_fact_tags could be one argument #665

Open

Split in report_trusted_fact_tags and report_fact_tags

0a59781

murdok5 added 2 commits November 5, 2020 09:41

update params and readme for clarity on trusted report tags

c3a779d

add 'trusted' level to truste facts hash

8f14548

murdok5 requested a review from a team as a code owner November 5, 2020 17:54

murdok5 added 2 commits November 5, 2020 10:34

increase debugging

510a635

increase debugging

4888b23

kayayarai requested changes Nov 5, 2020

View reviewed changes

fix typo and comment out debugging

e4a7814

kayayarai reviewed Nov 5, 2020

View reviewed changes

README.md Outdated Show resolved Hide resolved

Update README.md

57d9cfd

Co-authored-by: Kari Halsted <[email protected]>

albertvaka reviewed Nov 6, 2020

View reviewed changes

kayayarai approved these changes Nov 6, 2020

View reviewed changes

albertvaka added 2 commits November 19, 2020 18:25

Remove 'trusted' level from the trusted facts hash

0bc0df6

So report_trusted_fact_tags is consistent wih trusted_facts_to_tags

Make linter pass

febfa1b

Disable Style/EmptyLiteral since it's way less readable to do { {} }

albertvaka merged commit efbe0bf into DataDog:master Nov 19, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add support for trusted fact tags and add info line for puppetserver … #662

add support for trusted fact tags and add info line for puppetserver … #662

murdok5 commented Oct 21, 2020

murdok5 commented Oct 21, 2020

albertvaka commented Oct 22, 2020

murdok5 commented Oct 22, 2020

albertvaka commented Oct 22, 2020

murdok5 commented Oct 22, 2020

albertvaka commented Oct 22, 2020

murdok5 commented Oct 24, 2020

albertvaka commented Oct 25, 2020

kayayarai left a comment

kayayarai Nov 5, 2020

murdok5 commented Nov 5, 2020

albertvaka Nov 6, 2020 •

edited

Loading

albertvaka Nov 19, 2020

kayayarai left a comment

add support for trusted fact tags and add info line for puppetserver … #662

add support for trusted fact tags and add info line for puppetserver … #662

Conversation

murdok5 commented Oct 21, 2020

What does this PR do?

Motivation

Additional Notes

Describe your test plan

murdok5 commented Oct 21, 2020

albertvaka commented Oct 22, 2020

murdok5 commented Oct 22, 2020

albertvaka commented Oct 22, 2020

murdok5 commented Oct 22, 2020

albertvaka commented Oct 22, 2020

murdok5 commented Oct 24, 2020

albertvaka commented Oct 25, 2020

kayayarai left a comment

Choose a reason for hiding this comment

kayayarai Nov 5, 2020

Choose a reason for hiding this comment

murdok5 commented Nov 5, 2020

albertvaka Nov 6, 2020 • edited Loading

Choose a reason for hiding this comment

albertvaka Nov 19, 2020

Choose a reason for hiding this comment

kayayarai left a comment

Choose a reason for hiding this comment

albertvaka Nov 6, 2020 •

edited

Loading