Add docs for Data Enrichment

[josephwegner]

Data Enrichment is a super useful feature when sending events to Keen IO. You can see more about it here: https://keen.io/docs/streams/data-enrichment-overview/. It would be super helpful in the Send Events to Keen IO section.

In the past, I started docs for it, but I never finished and got a pull request merged, so here are some docs I wrote that you can choose to work off of:

Data enrichment

Keen IO can enrich event data by parsing or joining it with other data sets. This is done through the concept of “add-ons”.

To activate add-ons, you simply add some new properties within the “keen” namespace in your events. Detailed documentation for the configuration of our add-ons is available here.

Here is an example of using the Datetime parser. Let's assume you want to do a deeper analysis on the "purchases" event by day of the week (Monday, Tuesday, Wednesday, etc.) and other interesting Datetime components.

    keen.add_event("purchases", {
      "keen": {
        "addons": [
          {
            "name": "keen:date_time_parser",
            "input": {
              "date_time" : "keen.timestamp"
            },
            "output": "timestamp_info"
          }
        ]
      },
      "price": 500
    })

Other data enrichment add-ons are located in the API reference docs.

(@tbarn: copy and pasted from my comment so it shows up in the description)

[tbarn]

Removed a comment about a PR that would fix this but didn't get merged to avoid confusion :)

[tbarn]

Data Enrichment is a super useful feature when sending events to Keen IO. You can see more about it here: https://keen.io/docs/streams/data-enrichment-overview/. It would be super helpful in the Send Events to Keen IO section.

In the past, I started docs for it, but I never finished and got a pull request merged, so here are some docs I wrote that you can choose to work off of:

Data enrichment

Keen IO can enrich event data by parsing or joining it with other data sets. This is done through the concept of “add-ons”.

To activate add-ons, you simply add some new properties within the “keen” namespace in your events. Detailed documentation for the configuration of our add-ons is available here.

Here is an example of using the Datetime parser. Let's assume you want to do a deeper analysis on the "purchases" event by day of the week (Monday, Tuesday, Wednesday, etc.) and other interesting Datetime components.

    keen.add_event("purchases", {
      "keen": {
        "addons": [
          {
            "name": "keen:date_time_parser",
            "input": {
              "date_time" : "keen.timestamp"
            },
            "output": "timestamp_info"
          }
        ]
      },
      "price": 500
    })

Other data enrichment add-ons are located in the API reference docs.

[mamat-rahmat]

I'd like to work on this. Just to make sure, do you mean this part?

[tbarn]

Yes, at the bottom here:

In its own section right before it gets into analysis would be great!

[mamat-rahmat]

I think for code example, i would use URL Parser as it simple enough to explain the idea. What do you think?

[tbarn]

Sure. It might be helpful to use that one and another one, especially since the Datetime Parser docs have been already partially written.

[tbarn]

Closed in #136