Skip to content
This repository has been archived by the owner on Apr 12, 2022. It is now read-only.

Commit

Permalink
Spellling/grammar checks in README and CONTRIBUTING
Browse files Browse the repository at this point in the history
  • Loading branch information
@timothyaaron
timothyaaron committed Nov 18, 2017
1 parent 4ef3245 commit 74e2a25
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 64 deletions.
65 changes: 16 additions & 49 deletions CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
@@ -1,31 +1,21 @@
# Contributing

When contributing to this repository, please first discuss the change you wish to make via issue,
email, or any other method with the owners of this repository before making a change.
When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct, please follow it in all your interactions with the project.

## Pull Request Process

1. Ensure any install or build dependencies are removed before the end of the layer when doing a
build.
2. Update the README.md with details of changes to the interface, this includes new environment
variables, exposed ports, useful file locations and container parameters.
3. Increase the version numbers in any examples files and the README.md to the new version that this
Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you
do not have permission to do that, you may request the second reviewer to merge it for you.
1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
2. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
3. Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.

## Code of Conduct

### Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, gender identity and expression, level of experience,
nationality, personal appearance, race, religion, or sexual identity and
orientation.
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.

### Our Standards

Expand All @@ -40,53 +30,30 @@ include:

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* The use of sexualized language or imagery and unwelcome sexual attention or advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
* Publishing others' private information, such as a physical or electronic address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a professional setting

### Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

### Scope

This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.

### Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [developers@youversion.com](developers@youversion.com). All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident.

Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.

### Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at [http://contributor-covenant.org/version/1/4][version]

[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/
This Code of Conduct is adapted from the [Contributor Covenant, version 1.4](http://contributor-covenant.org/version/1/4).
27 changes: 12 additions & 15 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# DNAQuery

DNAQuery is a command line utility to take [logdna](https://logdna.com) archives and load them into [BigQuery](https://cloud.google.com/bigquery/). This allows long term queryable storage of logs in BigQuery which can be considerably most cost effective. In our use case we want real time access to lots of different logs and long term storage of a subset of those logs. This approach has helped us find a balance between access & cost.
DNAQuery is a command line utility to take [LogDNA](https://logdna.com) archives and load them into [BigQuery](https://cloud.google.com/bigquery/). This allows long-term, queryable storage of logs in BigQuery (which is considerably more cost effective). In our use case we want real-time access to lots of different logs, and long-term storage of a subset of those logs. This approach has helped us find a balance between access and cost.

## Getting Started

Expand All @@ -10,26 +10,26 @@ DNAQuery has been tested on Go v1.9

## Prerequisites

- logdna account must have [Archiving](https://docs.logdna.com/docs/archiving) to S3 enabled
- a LogDNA account with [S3 Archiving](https://docs.logdna.com/docs/archiving) enabled
- a [Google Cloud Platform](https://cloud.google.com) account

## Configuring

`cp example.toml dnaquery.toml`

edit dnaquery.toml
Edit dnaquery.toml

All of these settings are currently required.

### AWS
Note: It's recommended that you create a new [IAM user](https://console.aws.amazon.com/iam/home) with `s3:GetObject` permission on the logdna archive previously setup
Note: It's recommended that you create a new [IAM user](https://console.aws.amazon.com/iam/home) with `s3:GetObject` permission on the LogDNA archive previously setup

```
[aws]
Key = "key123123123132" # Key for AWS IAM user
Secret = "secret123123123123" # Secret for AWS IAM user
Bucket = "logs" # name of bucket set in logdna archive setup above
LogPrefix = "a7112abc9d" # each archive file starts with a prefix specific to your logdna account
Bucket = "logs" # name of bucket set in LogDNA archive setup above
LogPrefix = "a7112abc9d" # each archive file starts with a prefix specific to your LogDNA account
```

### Storage
Expand All @@ -40,13 +40,13 @@ LogDirectory = 'logs' # temp local directory to download logs to and store resul
```

### Containers
Note: the term container here is used to be consistent with logdna's terminology
Note: the term container here is used to be consistent with LogDNA's terminology
```
[[containers]]
Name = "production-app" # name of container
Regex = '^([\d.]+) - \[([^\]]*)\] - - \[([^\]]*)\] "([^"]*)" (\d+) (\d+) "([^"]*)" "([^"]*)" (\d+) ([\d.]+) ([\d.:]+) (\d+) ([\d.]+) (\d+)$' # regex used to pull parts of logs out, currently we dont' use any named capture groups
Regex = '^([\d.]+) - \[([^\]]*)\] - - \[([^\]]*)\] "([^"]*)" (\d+) (\d+) "([^"]*)" "([^"]*)" (\d+) ([\d.]+) ([\d.:]+) (\d+) ([\d.]+) (\d+)$' # regex used to pull parts of logs out, currently we don't use any named capture groups
TimeGroup = 3 # the number of the capture group (1-based) in above regex that holds the time component of the log
TimeFormat = "2/Jan/2006:15:04:05 -0700" # the format of the time field using https://golang.org/pkg/time/#Parse
TimeFormat = "2/Jan/2006:15:04:05 -0700" # the format of the time field using https://golang.org/pkg/time/#Parse
[[containers.excludes]] # an array of tables for exclusions
Group = 4 # the number of the capture group in above regex to be used in the exclusion check
Contains = "ping" # excludes logs if the value here is contained in the string in the above capture group
Expand All @@ -57,7 +57,7 @@ Note: the term container here is used to be consistent with logdna's terminology
[gcp] # Google Cloud Project settings
ProjectID = "gcpproj" # name of GCP project
CredentialsFile = "gcp_credentials.json" # path to the credentials file downloaded from GCP
Bucket = "logdna_to_bq" # name of bucket in Cloud Storage to save results for ingestion into BigQuery, bucket will need to be created before first run
Bucket = "logdna_to_bq" # name of bucket in Google Cloud Storage to save results for ingestion into BigQuery, bucket will need to be created before first run
Dataset = "logdna" # BigQuery dataset
TemplateTable = "logdna" # currently DNAQuery uses a template table. More details below.
```
Expand All @@ -68,8 +68,6 @@ Currently the schema for the BigQuery table is specified by creating a table wit

## Usage

currently dnaquery requires a config file `dnaquery.toml` in the current directory

`dnaquery 2017-11-20`

## Tests
Expand All @@ -78,7 +76,7 @@ currently dnaquery requires a config file `dnaquery.toml` in the current directo

## Dependencies

This project uses [dep](https://github.com/golang/de) for dependency management
This project uses [dep](https://github.com/golang/dep) for dependency management

```
go get -u github.com/golang/dep/cmd/dep
Expand All @@ -87,8 +85,7 @@ dep ensure -update; dep prune

## Contributing

Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process
for submitting pull requests.
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests.

## Versioning

Expand Down

0 comments on commit 74e2a25

Please sign in to comment.