Uploaded image for project: 'Hadoop Common'
  1. Hadoop Common
  2. HADOOP-15230

org.apache.hadoop.metrics2.GraphiteSink is not implemented correctly

    XMLWordPrintableJSON

Details

    • Hide
      Corrected problems with GraphiteSink not having proper format in point tags. Format v1.1 suggests point tags should be delimited with ';' rather than '.' and also appear at the end of the metric name, not in the middle. Also removed risk of point tag value having empty space (will be replaced by '_').
      Show
      Corrected problems with GraphiteSink not having proper format in point tags. Format v1.1 suggests point tags should be delimited with ';' rather than '.' and also appear at the end of the metric name, not in the middle. Also removed risk of point tag value having empty space (will be replaced by '_').
    • metrics graphite
    • Patch

    Description

      org.apache.hadoop.metrics2.GraphiteSink's implementation has certain problems that would make it to generate metrics incorrectly.

      The problem lies with line 77 ~ 84 of the GraphiteSink java:

      for (MetricsTag tag : record.tags()) {
      if (tag.value() != null) {
      metricsPathPrefix.append(".");
      metricsPathPrefix.append(tag.name());
      metricsPathPrefix.append("=");
      metricsPathPrefix.append(tag.value());
      }
      }
      

      It produces point tags having name=value pair in the metrics. However, notice how the tags are added with '.' as its delimiters. Rather than using the '.' character, it should follow the following convention mentioned in the latest graphite doc of using ';' character.

      http://graphite.readthedocs.io/en/latest/tags.html

      Also, the value is not properly being escaped, meaning that if the value has a '.' character in it, it will easily confuse Graphite to accept it as a delimiter, rather than the value. A really good prime example is when the value is a hostname or ip address,

      metrics.example.Hostname=this.is.a.hostname.and.this.is.Metrics 10.0

      In this example, the since the value of the hostname contains '.', it is extremely hard for the receiving end to determine which part is hostname and which part is the rest of the metrics name. A good strategy is to convert any '.' character in the value to be converted to other characters, such as '_'.

      However, the best way would be to follow the latest metrics convention of using ';'

      metrics.example.and.this.is.Metrics;Hostname=this.is.a.hostname 10.0

      Attachments

        1. HADOOP-15230.007.patch
          24 kB
          Howard Yoo

        Issue Links

          Activity

            People

              howardyoo Howard Yoo
              howardyoo Howard Yoo
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

              Dates

                Created:
                Updated:

                Time Tracking

                  Estimated:
                  Original Estimate - Not Specified
                  Not Specified
                  Remaining:
                  Remaining Estimate - 0h
                  0h
                  Logged:
                  Time Spent - 0.5h
                  0.5h