https://github.com/salesforce/refocus-collector

https://github.com/salesforce/refocus-collector

refocus

Last synced: about 1 year ago
JSON representation

• Host: GitHub
• URL: https://github.com/salesforce/refocus-collector
• Owner: salesforce
• License: bsd-3-clause
• Created: 2017-05-15T19:08:45.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2023-10-02T18:18:19.000Z (over 2 years ago)
• Last Synced: 2024-04-08T00:13:15.511Z (about 2 years ago)
• Topics: refocus
• Language: JavaScript
• Size: 1.25 MB
• Stars: 8
• Watchers: 17
• Forks: 7
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: CODEOWNERS
  • Security: SECURITY.md

Awesome Lists containing this project

README

          
[![Coverage Status](https://coveralls.io/repos/github/salesforce/refocus-collector/badge.svg?branch=master)](https://coveralls.io/github/salesforce/refocus-collector?branch=master)

# refocus-collector

Note: this repository is infrequently maintained.

### Installation

Prerequisite: NPM and Node.js

* Install via Git Clone

    * ```git clone https://github.com/salesforce/refocus-collector.git```

    * ```cd refocus-collector```

    * ```npm install```

    * ```npm link```

    * try command ```refocus-collector```  or ```refocus-collector --help```

  Usage: ```refocus-collector [command] [options]```

### Commands

    Start collector for name, refocus url, API token, proxy for refocus and proxy for data source. refocusProxy and dataSourceProxy are optional arguments

    start --collectorName --refocusUrl --accessToken --refocusProxy --dataSourceProxy

    Stop given collector

    stop  --collectorName --refocusProxy

    Show status of collector

    status  --collectorName --refocusProxy

    Deregister given collector

    deregister  --collectorName --refocusProxy

    Reregister given collector. refocusProxy is an optional argument

    reregister  --collectorName --refocusUrl --accessToken --refocusProxy

    Display help for [cmd]

    help [cmd]

  Options:

    -n, --collectorName     specify the name of the collector

    -h, --help     output usage information

    -V, --version  output the version number

  Examples:

    $ refocus-collector --help

    $ refocus-collector start --collectorName=PRD_Collector_12345 --refocusUrl=https://refocus.foo.com --accessToken=eygduyguygijfdhkfjhkfdhg --refocusProxy=http://abcproxy.com --dataSourceProxy=http://xyzproxy.com

    $ refocus-collector stop --collectorName=PRD_Collector_12345

    $ refocus-collector status --collectorName=PRD_Collector_12345

    $ refocus-collector deregister --collectorName=PRD_Collector_12345

    $ refocus-collector reregister --collectorName=PRD_Collector_12345 --refocusUrl=https://refocus.foo.com --accessToken=eygduyguygijfdhkfjhkfdhg --refocusProxy=http://abcproxy.com

-----

- [Introduction to Collectors](docs/pages/collectorintro.md)

- [Introduction to Sample Generators](docs/pages/samplegenintro.md)

-----

# Version History

- 1.1.1

    - Simplify the heartbeat payload - send up all the process info, not just delta from last heartbeat

- 1.2.0

    - Reuse authentication token among generator clones until it expires.