CirrusSearchRequestSet.avsc

{
  "type": "record",
  "name": "CirrusSearchRequestSet",
  "namespace": "org.wikimedia.mediawiki.search",
  "doc": "A set of requests made by CirrusSearch to the elasticsearch user for a single php execution context",
  "fields": [
    {
      "name": "wikiId",
      "doc": "The wiki making this request, such as dewiki or enwiktionary",
      "type": "string"
    },
    {
      "name": "source",
      "doc": "Where the request is coming from. Typically: web, api or cli",
      "type": "string"
    },
    {
      "name": "identity",
      "doc": "A hash identifying the requestor. Includes the IP address and User Agent when available.",
      "type": "string"
    },
    {
      "name": "ip",
      "doc": "The IP address (either ipv4 or ipv6) in string notation",
      "type": [
        "null",
        "string"
      ],
      "default": null
    },
    {
      "name": "userAgent",
      "doc": "The HTTP User-Agent header, or null if not-applicable",
      "type": [
        "null",
        "string"
      ],
      "default": null
    },
    {
      "name": "backendUserTests",
      "doc": "List of backend tests the requests are participating in",
      "type": {
        "type": "array",
        "items": "string"
      }
    },
    {
      "name": "requests",
      "doc": "A list of requests made between mediawiki and elasticsearch in a single execution context",
      "type": {
        "type": "array",
        "items": {
          "name": "CirrusSearchRequest",
          "namespace": "org.wikimedia.mediawiki.search",
          "doc": "An individual request made between mediawiki and elasticsearch",
          "type": "record",
          "fields": [
            {
              "name": "query",
              "doc": "The actual search request",
              "type": "string"
            },
            {
              "name": "queryType",
              "doc": "The general type of query performed, such as full_text, prefix, etc.",
              "type": "string"
            },
            {
              "name": "index",
              "doc": "The list of indices the request was performed against",
              "type": {
                "type": "array",
                "items": "string"
              }
            },
            {
              "name": "tookMs",
              "doc": "The number of milliseconds between passing the query to the client library and getting the response back in the application",
              "type": [
                "null",
                "int"
              ],
              "default": null
            },
            {
              "name": "elasticTookMs",
              "doc": "The number of milliseconds the query took, according to the elasticsearch response",
              "type": [
                "null",
                "int"
              ],
              "default": null
            },
            {
              "name": "limit",
              "doc": "The maximum number of results requested by the application",
              "type": [
                "null",
                "int"
              ],
              "default": null
            },
            {
              "name": "hitsTotal",
              "doc": "The approximate total number of documents matching the query",
              "type": [
                "null",
                "int"
              ],
              "default": null
            },
            {
              "name": "hitsReturned",
              "doc": "The number of results returned to the application",
              "type": [
                "null",
                "int"
              ],
              "default": null
            },
            {
              "name": "hitsOffset",
              "doc": "The offset of the query",
              "type": [
                "null",
                "int"
              ],
              "default": null
            },
            {
              "name": "namespaces",
              "doc": "Each element is a mediawiki namespace id that was searched.",
              "type": {
                "type": "array",
                "items": "int"
              }
            },
            {
              "name": "suggestion",
              "doc": "The suggestion generated by elasticsearch, or null if not requested",
              "type": [
                "null",
                "string"
              ],
              "default": null
            }
          ]
        }
      }
    }
  ]
}

sample-message.avro

{
  "wikiId": "enwiki",
  "source": "web",
  "identity": "e1f59aac58ea9d5df32fcf45c4531634",
  "ip": "1.2.3.4",
  "userAgent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/44.0.2403.130 Safari/537.36",
  "backendUserTests": [],
  "requests": [
    {
      "query": "what happens to conciousness after death",
      "queryType": "full_text",
      "index": ["enwiki_content"],
      "tookMs": 27,
      "elasticTookMs": 18,
      "limit": 20,
      "hitsTotal": 1203,
      "hitsReturned": 20,
      "hitsOffset": 0,
      "namespaces": [0],
      "suggestion": "what happened to consciousness after death"
    }
  ]
}