Patch 2

CONTRIBUTING.md

@@ -0,0 +1,70 @@
+Contributing to the Netuitive Windows Agent
+==========================================
+Contributions are welcome and can be represented in many different ways as noted below. Help is 
+greatly appreciated and credit will always be given.
+
+
+Types of Contributions
+------------------------------
+
+### Reporting Bugs
+Report bugs on [the issues page](https://github.com/Netuitive/collectdwin/issues).
+With your bug report, please include:
+- Your operating system name and version.
+- Any details about your local setup that might be helpful in troubleshooting the issue.
+- Detailed steps to reproduce the bug.
+
+### Fixing bugs
+Find bugs at [the issues page](https://github.com/Netuitive/collectdwin/issues). Anything tagged with
+"bug" is open to be fixed. 
+With your fix, please include:
+- The issue number
+- A detailed commit message
+
+### Implementing Features
+Find features at [the issues page](https://github.com/Netuitive/collectdwin/issues). Anything tagged
+with "feature" is open to be implemented.
+With your feature, please include:
+- The issue number
+- A detailed commit message
+
+### Writing Documentation
+The Netuitive Windows Agent can always use documentation (more documentation is always better!). 
+Please document your features or usage as part of the official docs/wiki, in docstrings, 
+in blog posts, articles, or wherever you see fit.
+
+### Submitting Feedback
+File an issue at [the issues page](https://github.com/Netuitive/collectdwin/issues).
+If you are proposing a feature:
+- Explain how it would work in detail
+- Keep the scope as narrow as possible to make it easier to implement
+
+Workflow
+------------------------------
+
+1. Create a branch directly in this repo or a fork (if you don't have push access). Please name
+branches within this repository `feature/<description>` or `fix/description`. For example, 
+something like `feature/upgrade_agent_0.2.3-70`.
+
+1. Create an issue or open a pull request (PR). If you aren't sure your PR will solve the issue
+or may be controversial, we're okay with you opening an issue separately and linking to it in 
+your PR. That way, if the PR is not accepted, the issue will remain and be tracked.
+
+1. Clone the fork/branch locally.
+
+1. Close (and reference) issues by the `closes #XXX` or `fixes #XXX` notation in the commit
+message. Please use a descriptive, useful commit message that could be used to understand why a
+particular change was made.
+
+1. Keep pushing commits to the initial branch using `--amend`/`--rebase` as necessary. Don't mix 
+unrelated issues in a single branch.
+
+1. Clean up the branch (rebase with master to synchronize, squash, edit commits, test, etc.) to
+prepare for it to be merged.
+
+1. If you didn't open a pull request already, do so now. 
+
+1. After reviewing your commits for documentation, passed continuous integration (CI) tests, 
+version bumps, changelogs, and good, descriptive commit messages, a project maintainer can merge your request.
+
+1. Create/update the changelog if necessary.

README.md

@@ -1,7 +1,12 @@
-#Netuitive-CollectdWin
+CloudWisdom Windows Agent
+========================
 
-CollectdWin is a MS Windows service which collects, aggregates and publishes windows performance counters and attributes. CollectdWin is similar in concept and design to Collectd (https://collectd.org).
+The CloudWisdom Windows Agent leverages CollectdWin to collect, aggregate, and publish windows performance counters and attributes to CloudWisdom. It is designed to expose crucial metrics from your Windows machines and display them in a meaningful way in [CloudWisdom](https://www.virtana.com/products/cloudwisdom/). 
 
-This version was forked to add Write Netuitive and other plugins.
+See the [Virtana Windows agent docs](https://docs.virtana.com/en/windows-agent.html) or the [wiki](../../wiki) for more information, or contact Netuitive support at [cloudwisdom.support@virtana.com](mailto:cloudwisdom.support@virtana.com).
+
+Changes to CollectdWin
+-----------------------
+
+The base functionality of CollectdWin remains in our fork: exposing windows performance counters for collection and monitoring. The CloudWisdom Windows Agent diverges from CollectdWin by extending the collection to non-numeric values such as attributes, events, and relationships. Netuitive created plugins to read Windows events and attributes as well as plugins to write to [CloudWisdom](https://www.virtana.com/products/cloudwisdom/) and [StatsD](https://github.com/etsy/statsd). Netuitive also changed the underlying framework to support collection and representation of elements of different types and metrics from remote sources.
 
-For more info, see the [wiki](../../wiki)

src/CollectdWinService/CollectableValue.cs

@@ -137,13 +137,15 @@ internal class EventValue : CollectableValue
         public long Id { get; set; }
         public string Message { get; set; }
         public string Level { get; set; }
+        public string Title { get; set; }
         public long Timestamp { get; set; }
-        private const string JSON_FORMAT = @"{{""level"": ""{0}"", ""source"":""{1}"", ""message"":""{2}"", ""timestamp"": {3} }}";
+        private const string JSON_FORMAT = @"{{""level"": ""{0}"", ""source"":""{1}"", ""title"":""{2}"", ""message"":""{3}"", ""timestamp"": {4} }}";
 
-        public EventValue(string hostname, long timestamp, int nLevel, string message, long id)
+        public EventValue(string hostname, long timestamp, int nLevel, string title, string message, long id)
         {
             Level = EventValue.levelToString(nLevel);
             Timestamp = timestamp;
+            Title = title;
             Message = message;
             HostName = hostname;
             Id = id;
@@ -154,27 +156,6 @@ public EventValue(string hostname, long timestamp, int nLevel, string message, l
             TypeInstanceName = "";
         }
 
-        public static int levelToInt(string level)
-        {
-            switch (level)
-            {
-                case "CRITICAL":
-                    return 1;
-                case "ERROR":
-                    return 2;
-                case "WARN":
-                    return 3;
-                case "WARNING":
-                    return 3;
-                case "INFO":
-                    return 4;
-                case "DEBUG":
-                    return 5;
-                default: // not specified
-                    return -1;
-            }
-        }
-
         public static string levelToString(int level)
         {
             switch (level)
@@ -210,7 +191,7 @@ public override bool Equals(object obj)
 
         public override string getJSON()
         {
-            return string.Format(JSON_FORMAT, Level, HostName, Message, Timestamp*1000);
+            return string.Format(JSON_FORMAT, Level, HostName, Title, Message, Timestamp*1000);
         }
 
     }

src/CollectdWinService/CollectdWinService.cs

@@ -15,6 +15,9 @@ public CollectdWinService()
 
         protected override void OnStart(string[] args)
         {
+            // Request additional service startup time. Configuring the metrics can take a little while
+            RequestAdditionalTime(30000);
+
             StartService(args);
         }
 

src/CollectdWinService/CollectdWinService.csproj

@@ -122,6 +122,7 @@
   </ItemGroup>
   <ItemGroup>
     <Compile Include="Aggregator.cs" />
+    <Compile Include="ErrorCodes.cs" />
     <Compile Include="WriteAmqpPlugin.cs" />
     <Compile Include="CollectableValue.cs" />
     <Compile Include="config\WriteAmqpPluginConfig.cs" />

src/CollectdWinService/ErrorCodes.cs

@@ -0,0 +1,16 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+
+namespace BloombergFLP.CollectdWin
+{
+    public static class ErrorCodes
+    {
+        public static readonly int ERROR_READ_EXCEEDED_CYCLE_TIME = 1;
+        public static readonly int ERROR_WRITE_EXCEEDED_CYCLE_TIME = 2;
+        public static readonly int ERROR_EXCEEDED_MAX_QUEUE_LENGTH = 3;
+        public static readonly int ERROR_UNHANDLED_EXCEPTION = 4;
+        public static readonly int ERROR_CONFIGURATION_EXCEPTION = 5;
+    }
+}

src/CollectdWinService/MetricsCollector.cs

@@ -28,7 +28,9 @@ public MetricsCollector()
             var config = ConfigurationManager.GetSection("CollectdWinConfig") as CollectdWinConfig;
             if (config == null)
             {
-                Logger.Error("Cannot get configuration section");
+                LogEventInfo logEvent = new LogEventInfo(LogLevel.Error, Logger.Name, "Cannot get configuration section");
+                logEvent.Properties.Add("EventID", ErrorCodes.ERROR_CONFIGURATION_EXCEPTION);
+                Logger.Log(logEvent);
                 return;
             }
 
@@ -140,7 +142,10 @@ private void ReadThreadProc()
                                     _collectedValueQueue.Dequeue();
                                     if ((++numMetricsDropped%1000) == 0)
                                     {
-                                        Logger.Error("Number of metrics dropped : {0}", numMetricsDropped);
+                                        LogEventInfo logEvent = new LogEventInfo(LogLevel.Error, Logger.Name, "Exceeded max queue length");
+                                        logEvent.Properties.Add("EventID", ErrorCodes.ERROR_EXCEEDED_MAX_QUEUE_LENGTH);
+                                        Logger.Log(logEvent);
+                                        Logger.Warn("Number of metrics dropped : {0}", numMetricsDropped);
                                     }
                                 }
                             }
@@ -151,18 +156,28 @@ private void ReadThreadProc()
                     double revisedInterval = (_interval - elapsed) * 1000;
                     if (revisedInterval / _interval < 0.1)
                     {
-                        Logger.Error("Read thread took {0} seconds out of {1} second cycle", elapsed, _interval);
+                        Logger.Warn("Read thread took {0} seconds out of {1} second cycle", elapsed, _interval);
                     }
                     if (revisedInterval > 0)
                         Thread.Sleep((int)revisedInterval);
+                    else
+                    {
+                        LogEventInfo logEvent = new LogEventInfo(LogLevel.Error, Logger.Name, "Read thread exceeded cycle time");
+                        logEvent.Properties.Add("EventID", ErrorCodes.ERROR_READ_EXCEEDED_CYCLE_TIME);
+                        Logger.Log(logEvent);
+                    }
+
                 }
                 catch (ThreadInterruptedException)
                 {
                     Logger.Info("Read thread interrupted");
                 }
                 catch (Exception exp)
                 {
-                    Logger.Error("ReadThreadProc() got exception : ", exp);
+                    LogEventInfo logEvent = new LogEventInfo(LogLevel.Error, Logger.Name, "Exception in ReadThreadProc()");
+                    logEvent.Exception = exp;
+                    logEvent.Properties.Add("EventID", ErrorCodes.ERROR_UNHANDLED_EXCEPTION);
+                    Logger.Log(logEvent);
                     Thread.Sleep(_interval * 1000);
                 }
             }
@@ -216,17 +231,22 @@ private void WriteThreadProc()
                             }
                         }
                     }
-                    double writeEnd = Util.GetNow();
-                    Logger.Info("Written {0} values in {1:0.00}s", numValues, (writeEnd - writeStart));
-
+                    double writeEnd = Util.GetNow();                    
                     double elapsed = writeEnd - writeStart;
                     double revisedInterval = (_interval - elapsed) * 1000;
+
                     if (revisedInterval / _interval < 0.1)
                     {
-                        Logger.Error("Write thread took {0} seconds out of {1} second cycle", elapsed, _interval);
+                        Logger.Warn("Write thread took {0} seconds out of {1} second cycle", elapsed, _interval);
                     }
-                    if (revisedInterval > 0)
+                    if (revisedInterval >= 0)
                         Thread.Sleep((int)revisedInterval);
+                    else
+                    {
+                        LogEventInfo logEvent = new LogEventInfo(LogLevel.Error, Logger.Name, "Write thread exceeded cycle time");
+                        logEvent.Properties.Add("EventID", ErrorCodes.ERROR_WRITE_EXCEEDED_CYCLE_TIME);
+                        Logger.Log(logEvent);
+                    }
 
                 }
                 catch (ThreadInterruptedException)
@@ -235,7 +255,10 @@ private void WriteThreadProc()
                 }
                 catch (Exception exp)
                 {
-                    Logger.Error("WriteThreadProc() got exception : ", exp);
+                    LogEventInfo logEvent = new LogEventInfo(LogLevel.Error, Logger.Name, "Exception in WriteThreadProc()");
+                    logEvent.Exception = exp;
+                    logEvent.Properties.Add("EventID", ErrorCodes.ERROR_UNHANDLED_EXCEPTION);
+                    Logger.Log(logEvent);
                     Thread.Sleep(_interval * 1000);
                 }
             }
@@ -258,7 +281,10 @@ private void AggregatorThreadProc()
                 }
                 catch (Exception exp)
                 {
-                    Logger.Error("AggregatorThreadProc() got exception : ", exp);
+                    LogEventInfo logEvent = new LogEventInfo(LogLevel.Error, Logger.Name, "Exception in AggregatorThreadProc()");
+                    logEvent.Exception = exp;
+                    logEvent.Properties.Add("EventID", ErrorCodes.ERROR_UNHANDLED_EXCEPTION);
+                    Logger.Log(logEvent);
                 }
             }
             Logger.Trace("AggregatorThreadProc() return");

src/CollectdWinService/PluginRegistry.cs

@@ -18,7 +18,9 @@ public PluginRegistry()
             var config = ConfigurationManager.GetSection("CollectdWinConfig") as CollectdWinConfig;
             if (config == null)
             {
-                Logger.Error("Cannot get configuration section");
+                LogEventInfo logEvent = new LogEventInfo(LogLevel.Error, Logger.Name, "Cannot get configuration section");
+                logEvent.Properties.Add("EventID", ErrorCodes.ERROR_CONFIGURATION_EXCEPTION);
+                Logger.Log(logEvent);
                 return;
             }
             foreach (PluginConfig pluginConfig in
@@ -37,7 +39,9 @@ public IList<ICollectdPlugin> CreatePlugins()
                 Type classType = Type.GetType(entry.Value);
                 if (classType == null)
                 {
-                    Logger.Error("Cannot create plugin:{0}, class:{1}", entry.Key, entry.Value);
+                    LogEventInfo logEvent = new LogEventInfo(LogLevel.Error, Logger.Name, String.Format("Cannot create plugin:{0}, class:{1}", entry.Key, entry.Value));
+                    logEvent.Properties.Add("EventID", ErrorCodes.ERROR_CONFIGURATION_EXCEPTION);
+                    Logger.Log(logEvent);
                     continue;
                 }
                 var plugin = (ICollectdPlugin) Activator.CreateInstance(classType);

src/CollectdWinService/Properties/AssemblyInfo.cs

@@ -35,4 +35,4 @@
 // by using the '*' as shown below:
 // [assembly: AssemblyVersion("1.0.*")]
 
-[assembly: AssemblyVersion("0.6.*")]
+[assembly: AssemblyVersion("0.7.1.*")]