Funtoo-Report - v3.1.0 Released!

[haxmeister]

Presenting V3.1.0 release of Funtoo-Report which includes usability improvements and performance statistics for the tool itself

This release contains no breaking changes.

Improvements in this release include:

• added bash-completion for the tool
• added zsh-completion for the tool
• reporting how long each section took to generate
• added Changes file to track changed code and added features
• added config check logic, that will check configuration file for errors
• allowing to autofix Field Limit up to 10k

We appreciate everyone's support and the tremendous amount of thought that continues to go into this piece of software. Everyone who understands the value of these types of statistics is encouraged to give the tool a try. A lot of work has been done to attempt to make the software run as smoothly as possible with minimal resources. You can read or contribute to the code at https://github.com/haxmeister/funtoo-reporter . The tool is designed to not report anything that would allow a person to be unwittingly identified. That includes such thoughts as "not showing where user file systems are mounted" and other  ideas that will keep full anonymity. Should you have ideas for improvement or warnings about anything that violates those design goals, please feel free to report it to us on github. 

 

Installation:

emerge -av Funtoo-Report

Operation:

The reporting tool is intended to run with root privileges for access to key system files. Use the method most appropriate on your system

Just launching the program will show you a help menu:

'funtoo-report'

Funtoo anonymous data reporting tool usage:

funtoo-report
              -c, --config        Specify path to config file
              -u, --update-config Interactively updates the config file
              -l, --list-config   Lists the current configuration file's settings
              -j, --show-json     Shows the JSON report
              -s, --send          Sends the JSON report
              -d, --debug         Enables additional debug output
              -v, --verbose       Enables non-error output when sending
              -h, --help          Display this help text
              -V, --version       Prints the version and exits

Output can be omitted by modifying the config file (default `/etc/funtoo-report.conf`):

The --help option shows you the same output:

'funtoo-report --help'

The --version option shows you the script and module version numbers; ideally they should match:

'funtoo-report --version'

To see what data the report is generating use the show-json option:

'funtoo-report --show-json'

You may get an error that no config file is found:

Warning!
Could not open the configuration file at /etc/funtoo-report.conf
To generate a new configuration file use 'funtoo-report --update-config'

You can follow these warning instructions and the program will ask you which sections you want to enable in your config file

'funtoo-report --update-config'

You can send your report to the Elasticsearch database using the send option which can return a link to the data if successful in conjunction with --verbose:

'funtoo-report --send [--verbose]'

your report can be seen at: https://es.host.funtoo.org:9200/funtoo-2018.10/report/C5DOC2IB4MpucymM_TFy

You can get HTTP debugging output for the send command with the --debug or -d option:

'funtoo-report --debug --send'

Manual Configuration:

The reporting tool is completely anonymous and the individual categories that are in the report can be turned off or on by editing the config file. The config file is located at /etc/funtoo-report.conf by default, and will be autogenerated by the script if one is not present. All lines of the config file that are empty or start with # are ignored. The rest are read but may be ignored if they do not match any expected setting. You can manually change the settings from 'y' to 'n' to disable a particular category. Using the show-json option, you can confirm that this portion of the report is not being output, since the show-json option actually shows exactly what is reported to Elasticsearch.

Here is an example of all possible values in the config file

# To report kernel info including O.S. type, release and version
kernel-info:y

# Allows the reporter to search your /boot directory and list
# any kernels it finds
# (limited to kernel names that start with "kernel" or "vmlinuz")
boot-dir-info:y

# To report versions of key softwares on your system including
# portage, ego, python, gcc, and glibc
version-info:y

# To report the contents of /var/lib/portage/world
world-info:y

# To report profiles information
# the same as epro show-json
profile-info:y

# To report kit versions as reported by ego
# extracted from ego kit show
kit-info:y

# To report all installed packages
installed-pkgs:y

# To report hardware info as is typical from lspci
hardware-info:y

Shell completions

Options completion for GNU bash is available in share/bash-completion/funtoo-report.bash:

bash$ source share/bash-completion/funtoo-report.bash

Options completion for zsh is available in share/zsh-completion/_funtoo-report.

Uninstall

We are sorry to see you go!

You can uninstall the tool by running:

emerge -C Funtoo-Report

 

[savasten]

This may be a silly question but what is the purpose of this tool?

 

Thank you

 

Keith

[dlc]

It provides the developers with anonymous feedback on Funtoo package and release usage that informs task priority settings for available manpower regarding the distro's maintenance and enhancement.  The deployment of funtoo-report is designed to be painless for the user and not needing much attention.  The more installations that run funtoo-report, the better the picture the developers get of funtoo deployments; i.e., what's important to funtoo users.

[palica]

very well said. thank you @dlc. I will be posting some screenshots shortly so you get the bigger  picture.