Add support for timestamp timezone locale #2

ewohltman · 2017-12-23T23:21:19Z

Added support for displaying timestamps according to a timezone locale. This change should be fully backwards compatible with existing implementations of this library.

The Opts struct has a new field, TimestampLocale:

type Opts struct {
	// Original fields remain unaltered
	// TimestampLocale specifies a custom locale for the timestamp
	TimestampLocale *time.Location
}

In addition, the parseToJson method was updated to support the Opts struct change:

func (hook *Hook) parseToJson(entry *logrus.Entry) (*[]byte, error) {
	// Beginning unchanged

	// Add footer to embed
	if !hook.Opts.DisableTimestamp {
		if hook.Opts.TimestampLocale != nil {
			entry.Time = entry.Time.In(hook.Opts.TimestampLocale)
		}
	// Remainder unchanged
	}

	// Remainder unchanged
}

ewohltman · 2017-12-23T23:25:53Z

@kz Accepting pull requests for your library? 😄

kz · 2017-12-23T23:29:05Z

Hi @ewohltman - many thanks for your PR, and for the very detailed explanation. I definitely am accepting PRs. :) I'll take a look tomorrow and get back to you then!

ewohltman · 2017-12-24T00:27:38Z

Real world usage of your library (well, the fork for this pull request) in the wild: https://github.com/ewohltman/ephemeral-roles/blob/master/pkg/logging/logging.go

kz · 2017-12-24T13:18:36Z

Glad to see that the library is being used in the wild! I'll leave a thorough review shortly.

kz

@ewohltman - I've reviewed the code. discordrus.go looks good, however a few changes need to be made in README.md and discordrus_test.go. Thanks for your help so far!

Also, once you've implemented all changes, please can you squash your commits with the message Add support for timestamp timezone locale (#2)?

kz · 2017-12-24T12:41:08Z

README.md

 # discordrus | a [Discord](https://discordapp.com/) hook for [Logrus](https://github.com/Sirupsen/logrus) <img src="http://i.imgur.com/hTeVwmJ.png" width="40" height="40" alt=":walrus:" class="emoji" title=":walrus:"/> [![Travis CI](https://api.travis-ci.org/kz/discordrus.svg?branch=master)](https://travis-ci.org/kz/discordrus) [![GoDoc](https://godoc.org/github.com/puddingfactory/logentrus?status.svg)](https://godoc.org/github.com/kz/discordrus)

-**Current version:** v1.0.1
+**Current version:** v1.0.2


Please can you change this to v1.1.0? Your commit has added new functionality, so semver dictates a minor version increase!

kz · 2017-12-24T12:52:28Z

README.md

 	logrus.SetOutput(os.Stderr)
 	logrus.SetLevel(logrus.DebugLevel)

+	// Log timestamps in UTC


I don't think we'll need 37-55 as there should be a simpler way of approaching this (detailed below). Additionally, the example usage should be as straightforward as possible so most people can get an understanding of the API, so if there is additional usage to be documented, a ### H3 header could be used beneath the default usage.

If you want TimestampFormat to include the time zone at the end, could you test out your code using "Jan 2 15:04:05.00000 MST"? According to https://golang.org/pkg/time/#Time.String, MST would be replaced with the time zone during formatting, which would remove the need for L37-55 entirely.

Also, in general, if you do want to retrieve the time zone token, I believe there is a much simpler way of doing this using the Zone function. You can find a demonstration here: https://play.golang.org/p/OHKTfqqnwrR

Great tip! Maybe there is something special about "MST"? I too saw that in other documentation, however at the time I was testing using "UTC" so maybe that wasn't being parsed how I expected? Explains why I would have to explicitly get the time zone string myself and append it to the pattern since it wasn't being replaced.

✔

I had the same confusion around the same time I was writing discordrus. Basically, every token in the format (Jan, 2, 15, 04, 05, MST) actually have meanings behind them (month, date of month without trailing zero, hour, minute, seconds, time zone respectively). You'd think you could replace Jan with Feb, but this wouldn't work since the point of hardcoding the meanings to values is to prevent ambiguity (it wouldn't be very straightforward getting Go to parse 15:15:15000, for example).

The significance of the values chosen are explained well here:

https://stackoverflow.com/a/20531191/2102540

https://stackoverflow.com/a/28087574/2102540

kz · 2017-12-24T13:01:45Z

README.md

-			DisableTimestamp: false, // Setting this to true will disable timestamps from appearing in the footer
-			TimestampFormat: "Jan 2 15:04:05.00000", // The timestamp takes this format; if it is unset, it will take logrus' default format
-			EnableCustomColors: true, // If set to true, the below CustomLevelColors will apply
+			Username:            "",


Please be sure to keep the values from the old Opts.

kz · 2017-12-24T13:03:51Z

README.md

 				Fatal: 13631488,
 			},
-			DisableInlineFields: false, // If set to true, fields will not appear in columns ("inline")
+			DisableTimestamp: false,           // Setting this to true will disable timestamps from appearing in the footer


Can we keep the old ordering (although TimestampLocale should still be directly after TimestampFormat)? It's more likely for time-related details to be changed than level colours, so time-related fields should take precedent.

kz · 2017-12-24T13:05:24Z

README.md

-			DisableInlineFields: false, // If set to true, fields will not appear in columns ("inline")
+			DisableTimestamp: false,           // Setting this to true will disable timestamps from appearing in the footer
+			TimestampFormat:  timeStampFormat, // The timestamp takes this format; if it is unset, it will take logrus' default format
+			TimestampLocale:  nil,             // nil == time.Local, time.UTC, time.LoadLocation("America/New_York"), etc


I'd prefer the comment // The timestamp uses this locale; if it is unset, it will use time.Local. By convention all usage has been left until later in the README.

kz · 2017-12-24T13:05:48Z

README.md

 Username | Replaces the default username of the webhook bot for the sent message only | Username unchanged | Any non-empty string (2-32 chars. inclusive)
 Author | Adds an author field to the header if set | Author not set | Any non-empty string (1-256 chars inclusive)
-DisableInlineFields | Inline means whether Discord will display the field in a column (with maximum three columns to a row). Setting this to `true` will cause Discord to display the field in its own row. | false | bool 
+DisableInlineFields | Inline means whether Discord will display the field in a column (with maximum three columns to a row). Setting this to `true` will cause Discord to display the field in its own row. | false | bool


As specified above, the previous ordering should be kept.

kz · 2017-12-24T13:07:00Z

README.md

-    "os"
-	"github.com/Sirupsen/logrus"
+	"os"
+	"strings"


Having implemented the changes below, do make sure to remove unused imports.

kz · 2017-12-24T13:18:03Z

discordrus_test.go

 			Author:             "",                     // Setting this to a non-empty string adds the author text to the message header
 			DisableTimestamp:   false,                  // Setting this to true will disable timestamps from appearing in the footer
 			TimestampFormat:    "Jan 2 15:04:05.00000", // The timestamp takes this format; if it is unset, it will take logrus' default format
+			TimestampLocale:    time.UTC,               // The timestamp takes it's timezone from the provided locale


Previously, TimestampLocale was not specified so the entry's time would default to time.Local, so we should use time.Local instead.

ewohltman · 2017-12-24T17:23:45Z

@kz I believe all suggestions have been addressed, squashed, and pushed - thanks for the great feedback!

ewohltman · 2017-12-24T17:32:04Z

FYI: go test ./... did return successfully. I also updated my other project to depend on this updated fork and it's working as well!

kz · 2017-12-24T17:47:12Z

Everything looks good to me! I'll merge now.

kz · 2017-12-24T17:54:12Z

All tests passing! 🚀

Thanks very much for your PR. It's quite a useful feature to have!

ewohltman added 4 commits December 23, 2017 15:27

Add support for timestamp timezone locale

5982501

Add support for timestamp timezone locale

8564116

Add support for timestamp timezone locale

28c92b8

Add support for timestamp timezone locale

efddb6a

Add support for timestamp timezone locale

4659ba1

kz requested changes Dec 24, 2017

View reviewed changes

Add support for timestamp timezone locale (#2)

46c7f3e

kz added the enhancement label Dec 24, 2017

kz approved these changes Dec 24, 2017

View reviewed changes

kz merged commit 233680a into kz:master Dec 24, 2017

Add support for timestamp timezone locale #2

Add support for timestamp timezone locale #2

Uh oh!

Conversation

ewohltman commented Dec 23, 2017

Uh oh!

ewohltman commented Dec 23, 2017

Uh oh!

kz commented Dec 23, 2017

Uh oh!

ewohltman commented Dec 24, 2017

Uh oh!

kz commented Dec 24, 2017

Uh oh!

kz left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ewohltman commented Dec 24, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ewohltman commented Dec 24, 2017

Uh oh!

kz commented Dec 24, 2017

Uh oh!

kz commented Dec 24, 2017

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

kz left a comment •

edited

Loading

ewohltman commented Dec 24, 2017 •

edited

Loading