named-users-rsc.R

#! /usr/local/bin/Rscript

# Set CSV path for MAU data write
csv_path <- gsub(" ", "-", paste0("./rsc-user-counts-", Sys.time(), ".csv"))

# Set minimum date - default is 1 year ago
min_date <- as.POSIXct(Sys.Date() - 365)
max_date <- as.POSIXct(Sys.Date() + 1)

# Set monthly value
monthly <- FALSE

# Set debug value
debug <- FALSE

# Print Debug utility
print_debug <- function(msg) {
  if(debug) cat(msg, "\n")
}


if (!interactive()) {
   library(argparser, quietly = TRUE)
  p <- arg_parser("Active RStudio Connect User Counts. Note that if you are using the default SQLite database provider, RStudio Connect must be stopped to run this utility. This utility should be executed as root.")
  p <- add_argument(parser = p,
                    arg = "--min-date",
                    help = "Minimum date to compute user counts",
                    type = "character",
                    default = format(min_date, "%Y-%m-%d"))
  p <- add_argument(parser = p,
                    arg = "--max-date",
                    help = "Maximum date to compute user counts",
                    type = "character",
                    default = format(max_date, "%Y-%m-%d"))
  p <- add_argument(parser = p,
                    arg = "--output",
                    help = paste0("Path to write .csv file of user counts"),
                    type = "character",
                    default = csv_path)
  p <- add_argument(parser = p,
                    arg = "--monthly",
                    help = "Count active users by month",
                    flag = TRUE)
  p <- add_argument(parser = p,
                    arg = "--debug",
                    help = "Enable debug output",
                    flag = TRUE)
  
  argv <- parse_args(p)
  
  min_date <- as.POSIXct(argv$min_date)
  max_date <- as.POSIXct(argv$max_date)
  csv_path <- argv$output
  monthly <- argv$monthly
  debug <- argv$debug
}

# Generate audit logs using the usermanager CLI and read them into R
print_debug("Generating RStudio Connect audit log. Please note that RStudio Connect needs to be stopped in order to generate the audit log if you use the SQLite database provider.")
audit_log <- read.csv(text = system2("/opt/rstudio-connect/bin/usermanager", 
                                     c("audit", 
                                       "--csvlog", 
                                       paste0("--since ", as.Date(min_date)),
                                       paste0("--until ", as.Date(max_date))
                                     ), 
                                     stdout = TRUE, 
                                     stderr = FALSE),
                      stringsAsFactors = FALSE,
                      strip.white = TRUE,
                      header = FALSE)
names(audit_log) <- c("ID", "Time", "UserId", "UserDescription", "Action", "EventDescription")

# Filter logs
print_debug("Filtering audit log")
audit_log <- audit_log[audit_log$Action == "user_login", c("UserId", "UserDescription", "Time", "Action")]

# Create month column
print_debug("Extracting month from timestamp")
audit_log$Time <- as.POSIXct(audit_log$Time)
audit_log$Month <- format(audit_log$Time, format = "%Y-%m")

# Count user and month
print_debug("Counting sessions per user per month")
user_session_counts <- as.data.frame(table(audit_log$UserDescription, audit_log$Month))
names(user_session_counts) <- c("user", "month", "sessions")
user_session_counts$active <- user_session_counts$sessions > 0
user_session_counts$product <- "RStudio Connect"

# Unique user / month combinations
print_debug("Summarizing by unique username and month combinations")
monthly_users <- unique(audit_log[,c("UserDescription", "Month")])

# Calculate observations per month, which is equivalent to the number of active 
# users per month
if (monthly) {
  print_debug("Calculating user counts by month")
  counts <- as.data.frame(table(monthly_users$Month))
  names(counts) <- c("Month", "Active User Count")
} else {
  counts <- paste0(length(unique(monthly_users$UserDescription)), " unique RStudio Connect named users between ", format(min_date, "%Y-%m-%d"), " and ", format(max_date, "%Y-%m-%d"))
}
# Write CSV
print_debug(paste0("Writing user counts data to ", csv_path))
write.csv(user_session_counts, csv_path, row.names = FALSE)

# Print final user counts
print(counts, row.names = FALSE)