Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs for Data Enrichment #107

Closed
josephwegner opened this Issue Jan 19, 2017 · 7 comments

Comments

3 participants
@josephwegner
Copy link
Contributor

josephwegner commented Jan 19, 2017

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)

@keenlabs keenlabs deleted a comment from josephwegner Sep 27, 2017

@tbarn

This comment has been minimized.

Copy link
Contributor

tbarn commented Sep 27, 2017

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

@tbarn tbarn added the hacktoberfest label Sep 28, 2017

@tbarn

This comment has been minimized.

Copy link
Contributor

tbarn commented Sep 28, 2017

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

This comment has been minimized.

Copy link
Contributor

mamat-rahmat commented Oct 5, 2017

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

@tbarn

This comment has been minimized.

Copy link
Contributor

tbarn commented Oct 5, 2017

Yes, at the bottom here:

screen shot 2017-10-05 at 3 00 08 pm

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

@mamat-rahmat

This comment has been minimized.

Copy link
Contributor

mamat-rahmat commented Oct 5, 2017

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

@tbarn

This comment has been minimized.

Copy link
Contributor

tbarn commented Oct 5, 2017

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

@tbarn

This comment has been minimized.

Copy link
Contributor

tbarn commented Oct 10, 2017

Closed in #136

@tbarn tbarn closed this Oct 10, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.