1
0
mirror of https://github.com/Microsoft/sql-server-samples.git synced 2025-12-08 14:58:54 +00:00
Files
sql-server-samples/samples/features/r-services/ssms-custom-reports

SSMS Custom Reports

This sample provides custom reports for SQL Server R Services that can be viewed from SQL Server Management Studio. The reports can be used to view configuration information, resource usage, execution statistics, active sessions and other information about R Services.

Contents

About this sample
Before you begin
Run this sample
Sample details
Related links

About this sample

  • Applies to: SQL Server 2016 (or higher)
  • Key features:
  • Workload: SQL Server R Services
  • Programming Language: T-SQL, R
  • Authors: Umachandar Jayachandran
  • Update history: Custom reports for R Services to show configuration, resource usage & model management.

Before you begin

To run this sample, you need the following prerequisites.

Software prerequisites:

  1. SQL Server 2016 (or higher) with R Services installed
  2. SQL Server Management Studio

Run this sample

Installation instructions for R Services can be found here.

Steps:

  • Download a zip file containing the reports to a folder using one of the links below:
  • Open the custom reports from SQL Server Management Studio using the instructions from "Add a custom report to Management Studio" topic in SQL Server Books Online

Sample details

Custom reports for R Services allow you to perform the following tasks from Object Explorer in SQL Server Management Studio. Add the reports to the server name in Object Explorer.

  1. Configuration of R Services feature after Installation
  2. View list of R packages installed on the SQL Server instance
  3. View resource usage of R scripts and resource governance settings
  4. View list of extended events for R Services
  5. View execution statistics for R scripts
  6. View sessions that are currently executing R scripts

R Services - Configuration.rdl

This report can be used to view the installation settings of R Services and properties of the R runtime. You can also use this report to configure R Services after installation.

R Services - Packages.rdl

This report lists the R packages installed on the SQL Server instance and properties like version, name.

R Services - Resource Usage.rdl

This report can be used to view the CPU, Memory, IO consumption of SQL Server & R scripts execution. You can also view the memory setting of external resource pools.

R Services - Extended Events.rdl

This report can be used to view the extended events that are available to get more insights into R scripts execution.

R Services - Execution Statistics.rdl

This report can be used to view the execution statistics of R services. For example, you can get the total number of R scripts executions, number of parallel executions and frequently used RevoScaleR functions.

For additional content, see these articles:

SQL Server R Services - Upgrade and Installation FAQ

SQL Server R Services Tutorials