package
0.0.0-20250307055322-04d9774b42d2
Repository: https://github.com/snetsystems/cloudhub.git
Documentation: pkg.go.dev
# Packages
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Package filestore provides the ability to read pre-defined resources from a specified directory (--canned-path).
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Package memdb provides a transient layer to store the InfluxDB and Kapacitor configured via flags at Cloudhub start.
No description provided by the author
No description provided by the author
No description provided by the author
Package oauth2 provides http.Handlers necessary for implementing Oauth2 authentication with multiple Providers.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Package snowflake is copied directly from influxdb/pkg/snowflake to generate a universally unique uint64.
Package template provides functionality to work with templates.
# Functions
ValidateAnnotationTagKey checks whether a user supplied tag can be stored in Annotation.Tags.
# Constants
AllScope grants permission for all databases.
The kinds of CSP.
The kinds of CSP.
DBScope grants permissions for a specific database.
General errors.
General errors.
General errors.
General errors.
General errors.
General errors.
General errors.
General errors.
General errors.
General errors.
General errors.
General errors.
General errors.
General errors.
General errors.
General errors.
General errors.
General errors.
General errors.
General errors.
General errors.
General errors.
General errors.
General errors.
General errors.
General errors.
General errors.
General errors.
General errors.
General errors.
General errors.
General errors.
General errors.
General errors.
General errors.
General errors.
General errors.
General errors.
General errors.
General errors.
General errors.
General errors.
General errors.
General errors.
General errors.
The kinds of CSP.
InfluxDB is the open-source time-series database.
InfluxDBv2 is Influx DB 2.x with Token authentication.
InfluxEnteprise is the clustered HA time-series database.
InfluxRelay is the basic HA layer over InfluxDB.
LearnScriptPrefix TickScript ID Prefix.
MappingWildcard is the wildcard value for mappings.
The kinds of CSP.
The kinds of CSP.
PredictScriptPrefix TickScript ID Prefix.
WorkerLimit controls the number of concurrent goroutines using a semaphore.
# Variables
DeviceCategoryMap maps device category keys to their corresponding category names.
# Structs
AIConfig is to The Information to access to cloudhub AI.
AIKapacitor represents the information for Kapacitor login.
AITemplates is a config Template for Cloudhub AI.
Alerta sends the output of the alert to an alerta service.
AlertNodes defines all possible kapacitor interactions with an alert.
AlertRule represents rules for building a tickscript alerting task.
Annotation represents a time-based metadata associated with a source.
AnnotationTagFilter describes data used to filter a collection of Annotations by their Tags.
AuthConfig is the global application config section for auth parameters.
AutoGenerateLearnRule extends Learning Rule with an additional TaskTemplate field for automatic rule registration.
AutoGeneratePredictionRule extends Prediction AlertRule with an additional TaskTemplate field for automatic rule registration.
Axis represents the visible extents of a visualization.
BuildInfo is sent to the usage client to track versions and commits.
Cell is a rectangle and multiple time series queries to visualize.
CellColor represents the encoding of data into visualizations.
ColumnEncoding is the settings for a specific column of the Log Viewer UI.
Config is the global application Config for parameters that can be set via API, with different sections, such as Auth.
ConfigTemplate represents a configuration template for a task.
CSP is CSP connection information.
CSPQuery represents the attributes that a CSP may be retrieved by.
Dashboard represents all visual and query data for a dashboard.
DashboardCell holds visual and query information for a cell.
DashboardQuery includes state for the query builder.
Database represents a database in a time series source.
DBRP represents a database and retention policy for a time series source.
DecimalPlaces indicates whether decimal places should be enforced, and how many digits it should show.
DLNxRst represents the result of a deep learning process.
DLNxRstQuery represents the attributes that a DLNxRst may be retrieved by.
DLNxRstStg represents the result of a deep learning process.
DLNxRstStgQuery represents the attributes that a DLNxRst may be retrieved by.
DurationRange represents the lower and upper durations of the query config.
Email sends the alert to a list of email addresses.
Environment is the set of front-end exposed environment variables that were set on the server.
Exec executes a shell command on an alert.
Field represent influxql fields and functions from the UI.
GraphOptions is a type of options for a DashboardCell for graph.
GroupBy represents influxql group by tags from the UI.
The InternalEnvironment variable is an internally shared environment variable within the server.
Kafka sends alerts to any Kafka brokers specified in the handler config.
KapacitorNode adds arguments and properties to an alert.
KapacitorProperty modifies the node they are called on.
Layout is a collection of Cells for visualization.
Legend represents the encoding of data into a legend.
LoadTemplateConfig Load file info.
Log sends the output of the alert to a file.
LogViewerColumn is a specific column of the Log Viewer UI.
LogViewerConfig is the configuration settings for the Log Viewer UI.
A Mapping is the structure that is used to determine a users role within an organization.
Measurement represents a measurement in a time series source.
MLNxRst represents the result of a Machine Learning (ML) process.
MLNxRstQuery represents the attributes that a MLNxRst may be retrieved by.
NetworkDevice represents the information of a network device.
NetworkDeviceOrg represents the information of a network device group.
NetworkDeviceOrgQuery represents the attributes that a networkDeviceOrg may be retrieved by.
NetworkDeviceQuery represents the attributes that a NetworkDevice may be retrieved by.
OpsGenie sends alerts to opsgenie.com.
Organization is a group of resources under a common name.
OrganizationConfig is the organization config for parameters that can be set via API, with different sections, such as LogViewer.
OrganizationQuery represents the attributes that a organization may be retrieved by.
PagerDuty sends alerts to the pagerduty.com service.
Permission is a specific allowance for User or Role bound to a scope of the data source.
Point is a field set in a series.
Post will POST alerts to a destination URL.
Protoboard is a prototype of a dashboard that can be instantiated.
ProtoboardCell holds visual and query information for a cell.
ProtoboardData is the data of a Protoboard that can be instantiated into a dashboard, including a collection of cells.
ProtoboardMeta is the metadata of a Protoboard.
Pushover sends alerts to pushover.net.
Query retrieves a Response from a TimeSeries.
QueryConfig represents UI query from the data explorer.
Range represents an upper and lower bound for data.
RenamableField is a column/row field in a DashboardCell of type Table.
RetentionPolicy represents a retention policy in a time series source.
Role is a restricted set of permissions assigned to a set of users.
Sensu sends alerts to sensu or sensuapp.org.
Server represents a proxy connection to an HTTP server.
ServiceNow properties.
Slack sends alerts to a slack.com channel.
SNMPConfig is Connection Config.
Source is connection information to a time-series data store.
SSHConfig is Connection Config.
TableOptions is a type of options for a DashboardCell with type Table.
Talk sends alerts to Jane Talk (https://jianliao.com/site).
TCP sends the alert to the address.
Telegram sends alerts to telegram.org.
Template represents a series of choices to replace TemplateVars within InfluxQL.
TemplateBlock is TickScript Template Params.
TemplateQuery is used to retrieve choices for template replacement.
TemplateValue is a value use to replace a template in an InfluxQL query.
TemplateVar is a named variable within an InfluxQL query to be replaced with Values.
TimeShift represents a shift to apply to an influxql query's time range.
Topology is represents represents an topology.
TopologyOptions represents various settings for displaying elements of the topology.
TopologyQuery represents the attributes that a topology may be retrieved by.
TriggerValues specifies the alerting logic for a specific trigger type.
User represents an authenticated user.
UserQuery represents the attributes that a user may be retrieved by.
VictorOps sends alerts to the victorops.com service.
Vsphere represents an vsphere.
# Interfaces
AnnotationStore represents storage and retrieval of annotations.
Assets returns a handler to serve the website.
BuildStore is the storage and retrieval of CloudHub build information.
ConfigStore is the storage and retrieval of global application Config.
ConfigTemplatesStore stores configuration templates.
CSPStore is the Storage and retrieval of information.
DashboardsStore is the storage and retrieval of dashboards.
Databases represents a databases in a time series source.
DLNxRstStgStore is the Storage and retrieval of information.
DLNxRstStore is the Storage and retrieval of information.
ID creates uniq ID string.
KVClient defines what each kv store should be capable of.
LayoutsStore stores dashboards and associated Cells.
Logger represents an abstracted structured logging implementation.
MappingsStore is the storage and retrieval of Mappings.
MLNxRstStore is the Storage and retrieval of information.
NetworkDeviceOrgStore is the Storage and retrieval of information.
NetworkDeviceStore is the Storage and retrieval of information.
OrganizationConfigStore is the storage and retrieval of organization Configs.
OrganizationsStore is the storage and retrieval of Organizations
While not necessary for the app to function correctly, it is expected that Implementors of the OrganizationsStore will take care to guarantee that the Organization.Name is unqiue.
ProtoboardsStore stores protoboards that can be instantiated into dashboards.
Response is the result of a query against a TimeSeries.
RolesStore is the Storage and retrieval of authentication information.
Router is an abstracted Router based on the API provided by the julienschmidt/httprouter package.
ServersStore stores connection information for a `Server`.
SourcesStore stores connection information for a `TimeSeries`.
TemplateLoader is Template Loader for CLoudhub AI Config.
TemplatesManager is Template config Manager.
Ticker generates tickscript tasks for kapacitor.
TimeSeries represents a queryable time series database.
TopologiesStore is the Storage and retrieval of information.
TSDBStatus represents the current status of a time series database.
UsersStore is the Storage and retrieval of authentication information
While not necessary for the app to function correctly, it is expected that Implementors of the UsersStore will take care to guarantee that the combinartion of a users Name, Provider, and Scheme are unique.
VspheresStore is the Storage and retrieval of information.
# Type aliases
Allowances defines what actions a user can have on a scoped permission.
AnnotationTags describes a set of user-defined tags associated with an Annotation.
DashboardID is the dashboard ID.
Error is a domain error encountered while processing CloudHub requests.
Permissions represent the entire set of permissions a User or Role may have.
Scope defines the location of access of a permission.
TemplateFieldType represents the type of template field.
TemplateID is the unique ID used to identify a template.
TemplateParamsMap is TemplateParams Params.
TICKScript task to be used by kapacitor.