Uploaded image for project: 'Apache Drill'
  1. Apache Drill
  2. DRILL-7676

Improve documentation for httpd format plugin

    XMLWordPrintableJSON

    Details

    • Type: Improvement
    • Status: Open
    • Priority: Major
    • Resolution: Unresolved
    • Affects Version/s: 1.17.0
    • Fix Version/s: None
    • Component/s: Documentation
    • Labels:
      None

      Description

      The httpd format plugin documentation (https://drill.apache.org/docs/httpd-format-plugin/) speaks to the configuration required to setup the plugin, but has no information on the returned fields of the parser. As a casual drill user, after configuring the plugin, I was confused to receive over 100 fields in my first `SELECT * FROM` query, all of which had complex names and were opaque to understand.

       

      Conversation on the drill slack led to the info that the underlying parser is https://github.com/nielsbasjes/logparser which eventually yields that the parser has a complicated name/type/dissector structure. The logparser project itself doesn't describe what the hierarchy looks like, which is unfortunate.

       

      I'd really like a end-user understandable enhancement to the drill docs that try to walk users through what they will get back from this parser, touching on the various parts of the tree returned from this plugin. In particular, the inclusion of fields with `firstline` and `lastline` were of special confusion when I first encountered them

        Attachments

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              davidski David Severski
            • Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated: