ATSD R Package
Table of Contents
ATSD R Package enables R developers to communicate with Axibase Time Series Database; a non-relational clustered database for storing performance measurements from IT infrastructure resources such as servers, network devices, storage systems, and applications.
/sourcedirectory contains package source code and documentation.
/compileddirectory contains binary packages for Linux and Windows as well as installation instructions.
Manage ATSD connection. Set up and store ATSD URL, username, and password. Configure cryptographic protocol and enforce SSL certificate validation when using HTTPS connection.
show_connection(): Prints current values of the connection parameters. These values can differ from values in the configuration file.
set_connection(): Overrides connection parameters for the duration of the current R session without changing the configuration file. If called without arguments, the function sets the connection parameters from the configuration file, otherwise
fileargument defines the
connection.configfile to use.
save_connection(): Overrides connection parameters for the duration of the current R session without changing the configuration file.
Refer to Configure Connection for more information.
ATSD R Package provides functions for storing and retrieving time series and related meta data in ATSD:
to_zoo(): Builds a
zooobject from the given Data Frame.
query(): Retrieves historical time series data or forecasts from ATSD as a Data Frame object.
get_metrics(): Retrieves a list of metrics and associated tags from ATSD, and converts them to Data Frame object.
get_entities(): Retrieves a list of entities and associated tags from ATSD, and converts them to a Data Frame object.
get_series_tags(): Retrieves series tags for the defined metric and returns a Data Frame object. For each time series, the function enumerates tags and last update time associated with the series.
save_series(): Saves time series from a Data Frame into ATSD.
For more information about package functions and their usage, refer to Package Functions Documentation.
Stable release available via CRAN.
To install the alpha version from GitHub:
install.packages("devtools") library(devtools) install_github("axibase/atsd-api-r/source")
atsd package depends upon the installation of the following packages:
Review installed packages with the
To install required packages:
install.packages(c("RCurl", "httr", "zoo"))
Upon completion of package download, load the package into R to begin working with ATSD.
Review package documentation:
help(package = "atsd")
Package vignette contains detailed documentation and usage examples. View long-form documentation with
browseVignettes(package = "atsd")
For help with a particular function or package, use
? syntax followed by the package name:
atsd from the current R session:
detach("package:atsd", unload = TRUE)
To remove the package completely:
ATSD R Package is licensed under the