Files
tubestation/toolkit/components/telemetry/EventInfo.h
Georg Fritzsche 9385f14125 Bug 1302681 - Part 1: Extend Event Telemetry core for recording from addons. r=dexter
To cut down on complexity, we don't require specifying any expiry versions.
Given that these events will be recorded non-persistently from off-train add-ons, they can be expired by shipping new add-on releases.

We also start to use the new "record on release" terminology here instead of opt-in/opt-out, but are not changing the internal functionality yet.

Technically, this is implemented by keeping a separate registry for the dynamic event information.
Built-in & dynamic events are tracked with separate numeric ids, so introduce a common identifier for both, an EventKey.
For actual event storage, the events are treated the same as built-in events. They are simply bucketed into the 'dynamic' process storage.
This approach ends up duplicating code paths that use the event info, but keeps a single implementation for recording, storage & serialization.
2017-08-03 07:03:00 -04:00

58 lines
1.6 KiB
C

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2; -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#ifndef TelemetryEventInfo_h__
#define TelemetryEventInfo_h__
#include "TelemetryCommon.h"
// This module is internal to Telemetry. The structures here hold data that
// describe events.
// It should only be used by TelemetryEventData.h and TelemetryEvent.cpp.
//
// For the public interface to Telemetry functionality, see Telemetry.h.
namespace {
struct CommonEventInfo {
// Indices for the category and expiration strings.
uint32_t category_offset;
uint32_t expiration_version_offset;
// The index and count for the extra key offsets in the extra table.
uint32_t extra_index;
uint32_t extra_count;
// The day since UNIX epoch that this probe expires on.
uint32_t expiration_day;
// The dataset this event is recorded in.
uint32_t dataset;
// Which processes to record this event in.
mozilla::Telemetry::Common::RecordedProcessType record_in_processes;
// Convenience functions for accessing event strings.
const nsCString expiration_version() const;
const nsCString category() const;
const nsCString extra_key(uint32_t index) const;
};
struct EventInfo {
// The corresponding CommonEventInfo.
const CommonEventInfo& common_info;
// Indices for the method & object strings.
uint32_t method_offset;
uint32_t object_offset;
const nsCString method() const;
const nsCString object() const;
};
} // namespace
#endif // TelemetryEventInfo_h__