Contents

Telemetry data

Details of 1E product usage statistics gathered by Tachyon to help with 1E's continued product improvement initiative.

What data is collected?

At a high level, the following data is collected:

  • Instruction usage (by Instruction Definition and by day), and statistics on the type of resources attached to Instruction Definitions
  • 1E Client configuration details, versions, operating system variants, device types, age of installation, last connected time and status, and time zones
  • Registered Tachyon Portal applications and Tachyon Consumers
  • Database table sizes
  • Tachyon server component information and basic configuration
  • (Anonymized) Management Group information (number of devices)
  • Tachyon upgrade history

Tachyon will periodically send summarized, statistical information about usage of the product to 1E. This enables 1E to improve your experience with Tachyon as it helps us understand how features are being used, focus future development, ensure we continue to support the Operating Systems you currently use, spot early warning signs of potential issues and identify instructions that may be causing issues or could be improved. No personally identifiable data is collected. The data is compressed, encrypted and sent to 1E through email.

By default, Tachyon collects data continuously and sends a compressed and encrypted summary by email to 1E every Friday at 23:40 UTC.

How to configure the frequency this data is sent to 1E is described here: Tachyon Server post-installation tasks: Enabling or disabling Telemetry.

Metrics

The following tables list all the telemetry metrics. Numeric values are integers unless otherwise stated.

On this page:

Application

PurposeA row for each registered Tachyon Portal application and its current version
Instance formatApplicationName
Example instance
Explorer
Value format

Version number

Example value5.1.0.20
Notes

Sourced from Application table in the TachyonMaster database.

ClientAgeMonths

PurposeA row for number-of-months-ago, and how many 1E clients were "first seen" within that number of months ago
Instance formatNumberOfMonthsAgo
Example instance
7
Value format

Count of number of devices

Example value42
Notes

Sourced from Device table in the TachyonMaster database.

Based on calendar months, rather than multiples of 30 days - e.g. if today is 2nd July, a device "first seen" on the 30th June will be counted as first seen as one month ago.

An instance of zero means "within the last month".

Can be used to determine client deployment rate.

ClientConfiguration

PurposeA row for each unique combination encoded of 1E Client configuration reported by 1E Client telemetry, and the number of clients in that configuration state
Instance format"1EClientConfiguration"
Example instance
"NM:E0505,PX:0,TAC:40AA4A,TAI:3FFE3,TUI:60080006"
Value format

Number of clients with that configuration

Example value
88
Notes

Sourced from Device table in the TachyonMaster database.

ClientConnectivity

PurposeA row for each combination of current online/offline status, Switch identifier and connectivity flags, and the number of clients in that state
Instance formatOnlineStatus|SwitchId|ConnectivityFlags
Example instances
Online|1|384
Offline|0|384
Value format

Count of number of devices for that combination

Example value42
Notes

Sourced from Device table in the TachyonMaster database.

Where devices are offline, their connection flags represent the values as they were at the time of their last connection.

ClientLastSeenDays

PurposeA row for day-based milestones, and the number of clients which have been "seen" (i.e. connected to the Switch) within that milestone.
Instance formatNumberOfDays
Example instance
7
Value format

Count of number of devices

Example value42
Notes

Sourced from Device table in the TachyonMaster database.

Milestones are 1, 2, 4, 7, 30, 90 and 365 days.

The numbers will be cumulative, because a device which has been since in the last 1 day will also be counted in 2 days, 4 days, 7 days, etc.

ClientOsVersion

PurposeA row for each combination of operating system variant and architecture, and the total number of devices running that OS
Instance formatDeviceType|OsVersionText|OsArchitecture|VirtualizationPlatform
Example instances
Desktop|CentOS Linux release 8.2.2004 (Core) |x64|Hyper-V
Desktop|Red Hat Enterprise Linux release 8.1 (Ootpa)|x64|Hyper-V
Desktop|Ubuntu 18.04.4 LTS|x64|Hyper-V
Desktop|Windows 10 Pro N 2004|x86|Hyper-V
Desktop|Windows 7 Enterprise|x86| <- absence of Virtualization platform implies physical device
Server|Windows Server 2016 Standard 1607|x64|
Value format

Count of number of devices running that OS variant

Example value42
NotesSourced from Device table in the TachyonMaster database.

ClientTimeZone

PurposeA row for each timezone in which client devices exist, and the number of client devices in that timezone
Instance formatTimeZoneIdentifier
Example instances
Europe/London
Asia/Calcutta
Value format

Count of number of devices detected in that timezone

Example value42
NotesSourced from Device table in the TachyonMaster database.

ClientVersion

PurposeA row for each combination of 1E Client variant and version, and the total number of devices running that client
Instance formatClientVariant|ClientVersionNumber
Example instances
Windows|5.1.0.885
Linux|5.0.0.234
Value format

Count of number of devices running that variant/version of the 1E Client

Example value182
NotesSourced from Device table in the TachyonMaster database.

Component

PurposeA row for each Tachyon server component, and the number of registered instances of that component
Instance formatComponent
Example instances
BackgroundChannel
SwitchConfiguration.2
Value format

For components other than the Switch, a count of instances of that component

For Switch components, a pipe-delimited sequence of:

  • X w - number of configured workers
  • X s - number of configured slots
  • X seclvl - configured security level
  • X switches - number of Switches with this configuration
  • X cores - number of cores bound to Switches with this configuration
Example values
2 (for non-Switch components)
SwitchConfiguration.2,1 w|10 s|5 seclvl|1 switches|1 cores
Notes

Sourced from SwitchConfiguration, Switch, BackgroundChannel, CoreApiConfiguration tables in the TachyonMaster database.

Consumer

PurposeA row for each registered Tachyon API consumer, and whether it is flagged as enabled
Instance formatConsumer
Example instance
CmConsoleExtensions
Value format

0 = disabled, 1 = enabled

Example value1 (i.e. enabled)
Notes

Sourced from Consumer table in the TachyonMaster database.

InstructionDefinitionUse

PurposeA row for each registered instruction definition, showing its total usage to date
Instance formatInstruction Definition Name|Instruction Definition Version
Example instance
1E-Explorer-TachyonAgent-AgentConnectionDiagnostics|17.3
Value format

Pipe-delimited sequence of:

  • X use - number of times the instruction definition has been run
  • X targeted - total number of devices targeted
  • X sent - total number of devices to which this instruction has been sent
  • X no data - total number of "success, no content" responses
  • X error - total number of "error" responses
  • X not_impl - total number of "not implemented" responses
  • X too_large - total number of "response too large" responses
  • X success_rows - total number of rows of data returned in responses
  • X mb_sent - total number of megabytes of network traffic sent from Switch to 1E Client
  • X mb_recv - total number of megabytes of network traffic received by Switch from 1E Client
  • X mb_urecv - total number of megabytes of equivalent uncompressed network traffic received by Switch from 1E Client

All the values above are based on the sum of all executions of that instruction definition.

Example value
2 use|900 targeted|876 sent|1 no_data|3 error|7 not_impl|0 too_large|52286 success_rows|17 mb_sent|35 mb_recv|208 mb_urecv
Notes

Sourced from InstructionDefinition and InstructionStatistics tables in the TachyonMaster database.

If an instruction definition is updated, this row reflects usage only of the most recent version of that instruction definition.

InstructionResourceCount

PurposeA row for each type of instruction resource (i.e. file attached to an instruction definition), and the total number of resources of that type
Instance formatResourceType
Example instance
Perl
Value format

Total number of resources of that type

Example value33
Notes

Sourced from InstructionDefinitionResource table in the TachyonMaster database.

InstructionResourceKb

PurposeA row for each type of instruction resource (i.e. file attached to an instruction definition), and the total size of resources of that type
Instance formatResourceType
Example instance
PowerShell
Value format

Total size in kilobytes

Example value69
Notes

Sourced from InstructionDefinitionResource table in the TachyonMaster database.

InstructionThroughput

PurposeA row for each day of system usage, and the instruction usage and network traffic (through instructions) incurred on that day
Instance formatLocalized date/time
Example instance
8/4/2020 12:00:00 AM +01:00
Value format

Pipe-delimited sequence of:

  • X instr - number of instructions run on that day
  • X targeted - total number of devices targeted
  • X sent - total number of devices to which instructions were sent
  • X no data - total number of "success, no content" responses
  • X error - total number of "error" responses
  • X not_impl - total number of "not implemented" responses
  • X too_large - total number of "response too large" responses
  • X success_rows - total number of rows of data returned in responses
  • X mb_sent - total number of megabytes of network traffic sent from Switch to 1E Client
  • X mb_recv - total number of megabytes of network traffic received by Switch from 1E Client
  • X mb_urecv - total number of megabytes of equivalent uncompressed network traffic received by Switch from 1E Client

All the values above are based on the sum of all executions of instructions on that day.

Example value
19 instr|94 targeted|94 sent|28 no_data|36 error|0 not_impl|0 too_large|2419 success_rows|0 mb_sent|0 mb_recv|1 mb_urecv
Notes

Sourced from InstructionStatistics table in the TachyonMaster database.

ManagementGroup

PurposeA row for each management group (as defined in TachyonMaster), and the number of devices within that management group
Instance formatManagementGroupId|ManagementGroupType
Example instance
76|2
Value format

Number of devices in that management group

Example value
777
Notes

Sourced from ManagementGroup table in the TachyonMaster database.

Management group types are  (System = 0, Internal = 1, External = 2)

Table

PurposeA row for each table in the TachyonMaster database, and statistics about that table usage
Instance formatTableName
Example instance
PolicyRuleStatus
Value format

Pipe-delimited sequence of:

  • X rows - number of rows in the table
  • X kb_resv - total size (data and index) of reserved space for this table (i.e. space consumed on disk)
  • X kb_data - total size of data for this table
  • X kb_idx - total size of index data for this table
Example value95 rows|144 kb_resv|16 kb_data|32 kb_idx
Notes

Sourced from SQL table metadata; this data may not be available if the account used to perform the query does not have permissions to query sys.* tables for TachyonMaster database.

The query to derive this information is based on the query used by SQL Server Management Studio to build the "Disk Usage" report.

Upgrade

PurposeA row for major/minor database install/upgrade event, and the date/time of that event
Instance formatVersionNumber
Example instance
5.1.0.607
Value format

Localized date/time

Example value
8/4/2020 11:10:33 PM +01:00
Notes

Sourced from AppliedChanges2 table in the TachyonMaster database.

The version number is derived from the "SourceVersion" column, which typically is the binary version of the database resource DLLs containing the database changes to apply.

Hotfixes will only be registered if they perform a database change.