METRON-1816: Date format Stellar function #1233

merrimanr · 2018-10-10T15:01:47Z

Contributor Comments

This PR adds a Stellar function that wraps the Java SimpleDateFormat class. The first argument is a date format string and is required. The second argument is epoch time and is optional (defaults to current time). The third argument is a timezone and is also option (default time zone of the environment is used if missing).

Testing

This has been tested in full dev:

Spin up full dev and launch the Stellar REPL. The DATE_FORMAT function should be available:

Stellar, Go!
Functions are loading lazily in the background and will be unavailable until loaded fully.
{}
[Stellar]>>> %functions DATE
DATE_FORMAT, IS_DATE

Create a variable and set it to an epoch time:

[Stellar]>>> epoch := 1472131630748L
1472131630748

Use the DATE_FORMAT function to format the value in the epoch field created in the previous step. The result should be a correctly formatted date that matches the format string, epoch time and timezone:

[Stellar]>>> DATE_FORMAT('EEE MMM dd yyyy hh:mm:ss zzz', epoch, 'EST')
Thu Aug 25 2016 08:27:10 EST

Format the date using the default timezone. The result should match the default timezone of your environment:

[Stellar]>>> DATE_FORMAT('EEE MMM dd yyyy hh:mm:ss zzzz', epoch)
Thu Aug 25 2016 01:27:10 Coordinated Universal Time

Format the date using the current time:

[Stellar]>>> DATE_FORMAT('EEE MMM dd yyyy hh:mm:ss zzz', 'GMT')
Tue Oct 09 2018 10:13:24 GMT

Format the date using the current time and default time zone:

[Stellar]>>> DATE_FORMAT('EEE MMM dd yyyy hh:mm:ss zzzz')
Tue Oct 09 2018 10:12:54 Coordinated Universal Time

Pull Request Checklist

Thank you for submitting a contribution to Apache Metron.
Please refer to our Development Guidelines for the complete guide to follow for contributions.
Please refer also to our Build Verification Guidelines for complete smoke testing guides.

In order to streamline the review of the contribution we ask you follow these guidelines and ask you to double check the following:

For all changes:

Is there a JIRA ticket associated with this PR? If not one needs to be created at Metron Jira.
Does your PR title start with METRON-XXXX where XXXX is the JIRA number you are trying to resolve? Pay particular attention to the hyphen "-" character.
Has your PR been rebased against the latest commit within the target branch (typically master)?

For code changes:

Have you included steps to reproduce the behavior or problem that is being changed or addressed?
Have you included steps or a guide to how the change may be verified and tested manually?
Have you ensured that the full suite of tests and checks have been executed in the root metron folder via:
```
mvn -q clean integration-test install && dev-utilities/build-utils/verify_licenses.sh 
```
Have you written or updated unit tests and or integration tests to verify your changes?
If adding new dependencies to the code, are these dependencies licensed in a way that is compatible for inclusion under ASF 2.0?
Have you verified the basic functionality of the build by building and running locally with Vagrant full-dev environment or the equivalent?

For documentation related changes:

Have you ensured that format looks appropriate for the output in which it is rendered by building and verifying the site-book? If not then run the following commands and the verify changes via site-book/target/site/index.html:
```
cd site-book
mvn site
```

Note:

Please ensure that once the PR is submitted, you check travis-ci for build issues and submit an update to your PR as soon as possible.
It is also recommended that travis-ci is set up for your personal repository such that your branches are built there before submitting a pull request.

simonellistonball · 2018-10-17T17:22:23Z

Looks like a very useful gap filler to me. +1 (non-binding) by inspection from me for sure.

ottobackwards · 2018-10-17T19:21:17Z

we should support the ISO date format constants so that users don't have to copy those formats.

ottobackwards

Just a couple of questions

ottobackwards · 2018-10-17T19:25:05Z

...llar/stellar-common/src/main/java/org/apache/metron/stellar/dsl/functions/DateFunctions.java

+  public static String getDateFormat(String format, Optional<Long> epochTime, Optional<String> timezone) {
+    Long time = epochTime.orElseGet(System::currentTimeMillis);
+    TimezonedFormat fmt = timezone.map(s -> new TimezonedFormat(format, s)).orElseGet(() -> new TimezonedFormat(format));
+    SimpleDateFormat sdf = formatCache.get(fmt).get();


are there any errors we need to wrap here?

There are no exceptions thrown by any calls in this method. What are you thinking we should do?

ottobackwards · 2018-10-17T19:25:27Z

.../stellar-common/src/test/java/org/apache/metron/stellar/dsl/functions/DateFunctionsTest.java

+  @Test(expected = ParseException.class)
+  public void testDateFormatNull() {
+    Object result = run("DATE_FORMAT('EEE MMM dd yyyy hh:mm:ss zzz', nada, 'EST')");
+  }


Can we have a test for an invalid format

simonellistonball · 2018-10-17T21:06:53Z

@ottobackwards wouldn't ISO constant support require us to do a check on the string before passing to the DateFormat instance, which on something that is likely to be run A LOT (i.e. multiple times for every message) could actually be a significant for performance, which I would say outweighs the convenience of not having to remember what the format looks like.

ottobackwards · 2018-10-17T21:37:56Z

I'm not sure what you mean? Can you elaborate?
Also, I'm actually thinking of using DateFormatter and the new java time api's:

https://docs.oracle.com/javase/8/docs/api/java/time/format/DateTimeFormatter.html

simonellistonball · 2018-10-17T21:52:37Z

I would worry about having to parse the strong argument to determine whether to use a constant or custom formatter, but I guess my concern is limited because we’re caching the formatter anyway so maybe I’m just over thinking it. Just very conscious we should keep performance at front of mind for this.

ottobackwards · 2018-10-17T21:56:02Z

This comes to mind for me, because using Nifi processors that take date formats and in other places I'm sick of cutting and pasting complex ISO formats into configurations when there are named formatters in java. This is just a suggestion, not a blocker.
We could create a new set of Stellar functions or something using an enum of formats like we do with other things in the future.

simonellistonball · 2018-10-17T22:01:35Z

Right, I hear that! I also really like the idea of a follow on function that returns the default formats as a great solution to this problem. Should we do that?

merrimanr · 2018-10-17T22:53:50Z

The existing Stellar date functions use SimpleDateFormat and already have a caching layer built in so I decided to reuse what was already there. Happy to switch to DateTimeFormatter here or in a follow on.

ottobackwards · 2018-10-18T17:16:32Z

+1

merrimanr added 2 commits October 10, 2018 09:47

initial commit

6db3f7d

fixed test

1fa9cb9

ottobackwards reviewed Oct 17, 2018

View reviewed changes

added test for invalid format

a2e8132

asfgit closed this in bf32fef Oct 18, 2018

justinleet pushed a commit to justinleet/metron that referenced this pull request Oct 25, 2018

METRON-1816 Date format Stellar function (merrimanr) closes apache#1233

4822f03

justinleet pushed a commit to justinleet/metron that referenced this pull request Oct 25, 2018

METRON-1816 Date format Stellar function (merrimanr) closes apache#1233

5fb061c

justinleet pushed a commit to justinleet/metron that referenced this pull request Oct 25, 2018

METRON-1816 Date format Stellar function (merrimanr) closes apache#1233

cc59fdf

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

METRON-1816: Date format Stellar function #1233

METRON-1816: Date format Stellar function #1233

merrimanr commented Oct 10, 2018

simonellistonball commented Oct 17, 2018

ottobackwards commented Oct 17, 2018

ottobackwards left a comment

ottobackwards Oct 17, 2018

merrimanr Oct 18, 2018

ottobackwards Oct 17, 2018

merrimanr Oct 18, 2018

simonellistonball commented Oct 17, 2018

ottobackwards commented Oct 17, 2018

simonellistonball commented Oct 17, 2018

ottobackwards commented Oct 17, 2018

simonellistonball commented Oct 17, 2018

merrimanr commented Oct 17, 2018

ottobackwards commented Oct 18, 2018

METRON-1816: Date format Stellar function #1233

METRON-1816: Date format Stellar function #1233

Conversation

merrimanr commented Oct 10, 2018

Contributor Comments

Testing

Pull Request Checklist

For all changes:

For code changes:

For documentation related changes:

Note:

simonellistonball commented Oct 17, 2018

ottobackwards commented Oct 17, 2018

ottobackwards left a comment

Choose a reason for hiding this comment

ottobackwards Oct 17, 2018

Choose a reason for hiding this comment

merrimanr Oct 18, 2018

Choose a reason for hiding this comment

ottobackwards Oct 17, 2018

Choose a reason for hiding this comment

merrimanr Oct 18, 2018

Choose a reason for hiding this comment

simonellistonball commented Oct 17, 2018

ottobackwards commented Oct 17, 2018

simonellistonball commented Oct 17, 2018

ottobackwards commented Oct 17, 2018

simonellistonball commented Oct 17, 2018

merrimanr commented Oct 17, 2018

ottobackwards commented Oct 18, 2018