telefonicaid/varufaker

Name: varufaker

Owner: Telefónica I+D

Description: Small utility to generate log traces based on a template, supporting Elastic Search, files and stdout

Created: 2016-01-27 10:40:09.0

Updated: 2018-04-12 08:57:48.0

Pushed: 2017-10-04 15:43:08.0

Homepage: null

Size: 31

Language: JavaScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

varufaker

Small utility to generate log traces based on a template, supporting elastic Search indexing, files and stdout

Usage

Install nodejs

install -g varufaker

h
faker --help

age: varufaker [options] [command]


mmands:

elastic   Writes traces to Elastic Search
stdout    Writes traces to stdout

tions:

-h, --help                 output usage information
-V, --version              output the version number
--every <every>            The delay between writes (milliseconds) [default: 1000]
                           Environment var: VA_EVERY
--iterations <iterations>  The number of traces to write [default: 100]
                           Environment var: VA_ITERATIONS
--template <template>      The template trace to write (see https://github.com/marak/Faker.js/) [default: ./lib/templates/tid.tpl]
                           Environment var: VA_TEMPLATE
--esurl <esurl>            The Elastic Search endpoint (add your user pass if Shield is enabled) [default: http://localhost:9200]
                           Environment var: VA_ESURL
--esindex <esindex>        The ElasticSearch index to write to (faker format supported) [default: varufaker-{{tid.yyyymmdd}}]
                           Environment var: VA_ESINDEX
--verbose                  Write debug info to the stderr
                           Environment var: VA_VERBOSE

amples:

ite to stdout
$ varufaker stdout

ite to a file
$ varufaker stdout > ./out.txt

ite to elasticsearch server directly[1]
$ varufaker elastic
] Only JSON templates are supported in this writer

API

t varufaker = require('varufaker');

writer = varufaker({ // ALL OPTIONAL 
 same options than in command line
ery: 1000,
erations: 1000,
mplate: '/path/to/template',
rbose: true,  // Defaults to false
 API only properties
mplateStr: 'my {{cool}} template', // This takes precedence over the template property above
 Add your own stream to get the traces in your logic
ream: {
// Called with the trace (string) to write 
write: function(str) { 
  // do whatever u want...
}



DD your own fakes to be used in the templates. E.g.
 "myCustomField": "{{custom.myFake}}" }
faker.faker.custom = {
Fake() {
return 'This is Sparta';



ite to stdout
er.stdout()
hen(success => process.stderr.write('All went fine? ' + success)); // dont write to stdout spurious traces ;)

rite to your custom stream
er.stream().then(...);

License

Copyright 2015, 2016 Telefónica Investigación y Desarrollo, S.A.U

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.