Cisco Content Delivery System Manager User Guide

Videoscape Distribution Suite Service Manager User Guide, Release 3.3 First Published: August 03, 2012 Last Modified: June 04, 2015 Americas Headquarters Cisco Systems, Inc. 170 West Tasman Drive San Jose, CA 95134-1706 USA http://www.cisco.com Tel: 408 526-4000 800 553-NETS (6387) Fax: 408 527-0883 THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE. ALL STATEMENTS, INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS. THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT SHIPPED WITH THE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE OR LIMITED WARRANTY, CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY. The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCB's public domain version of the UNIX operating system. All rights reserved. Copyright © 1981, Regents of the University of California. NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED "AS IS" WITH ALL FAULTS. CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, THOSE OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF DEALING, USAGE, OR TRADE PRACTICE. IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING, WITHOUT LIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCO OR ITS SUPPLIERS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: http:// www.cisco.com/go/trademarks. Third-party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. (1110R) Any Internet Protocol (IP) addresses used in this document are not intended to be actual addresses. Any examples, command display output, and figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses in illustrative content is unintentional and coincidental. Adobe Systems, Inc. Adobe LiveCycle Data Services ES2.5, Copyright © 2010, Adobe Systems, Inc. All Rights Reserved Oracle Copyright ©2012, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners. Red Hat, Inc. Red Hat and Red Hat Enterprise Linux are trademarks of Red Hat, Inc., registered in the United States and other countries. Other product names, symbols, and phrases used throughout this document (if any) are property of their respective owners. VDS Service Manager Analytics and Provisioning Portal User Guide © 2015 Cisco Systems, Inc. All rights reserved. CONTENTS Preface Preface xiii Audience xiii Document Conventions xiii Document Organization xv Reporting Problems xvi Obtaining Documentation and Submitting a Service Request xvi CHAPTER 1 Getting Started 1 Getting Started 1 Configuring Videoscape Distribution Suite Service Manager 2 Configuring CSV Files 3 Configuring VDS-IS for VDS-SM 4 Enabling Transaction Log 4 Enabling Session Tracking for ABR Services 8 Securing log transfer between VDS-IS and VDS-SM 9 Installing Certificates 10 Configuring Splunk for SSL 10 Validating Configurations 11 Verifying Log Ingestion in VDS-SM 11 Verifying Connectivity Between VDS-IS and VDS-SM 11 Checking for Data in VDS-SM 12 CHAPTER 2 Introduction to Videoscape Distribution Suite Service Manager Portal's User Interface 15 Videoscape Distribution Suite Service Manager Overview 15 Logging Into the User Interface 16 Changing Your Password 17 Alert Counter 17 Videoscape Distribution Suite Service Manager User Guide, Release 3.3 iii Contents VDS-SM Portal's User Interface Overview 18 User Interface Components 19 Main Menu 21 About 21 Configuration Icons 22 Role Based Access Control 24 CHAPTER 3 Home 29 Home Overview 29 Using the Scorecards 29 Network 32 Throughput 33 Concurrent Active Sessions 34 Cache Hit Ratio 35 Response Status Codes 36 Storage Usage 37 Protocol 38 Volume Delivered by Protocol 39 Total Requests by Protocol 40 Response Codes by Protocol 41 Cache Hit Ratio by Protocol 42 ABR Session Bitrate by Protocol 43 4xx Errors by Protocol 44 Content 45 Content by Client Request 45 Content by Bytes Transferred 46 Average ABR Session Bitrate by Content 47 Top Content by Delivery Server 48 Top Content by City 49 Top Content by Client Type 50 Viewers 51 Unique Viewers 52 Viewers by Client Type 53 Viewers by City 54 Viewers by ISP and Net Speed 55 Videoscape Distribution Suite Service Manager User Guide, Release 3.3 iv Contents Viewers by Download Size 56 Viewers by Session Duration 57 Content Origin 57 Enabling Ingest Transaction Log 58 Ingest Requests 58 Origin/Ingest Volume 59 Bytes Read by Protocol 60 Download Speed 61 Ingest Response Codes 62 Origin Server Failures 63 CHAPTER 4 Analytics 65 Analytics Overview 65 Analyze Metrics with Pivoting 65 Trends 67 Network 68 Volume 68 Throughput 68 Volume of Data Delivered 68 Delivery Services by Bytes Delivered 68 Origin/Ingest Volume 69 Average Download Speed 69 Predict Throughput 70 Caching 72 Cache Hit and Miss Rate by Request Count 72 % Cache Hit and Miss 73 Storage Usage 73 Cache Hit Ratio by Protocol 73 Request 74 Request Rate 74 Total Requests and Errors 75 Top Delivery Services by Request Count 75 Response 76 Response Count by Status Codes 76 Response Codes by Delivery Servers 76 Videoscape Distribution Suite Service Manager User Guide, Release 3.3 v Contents Response Codes by Service Routers 77 Sorted Delivery Services by Client Errors on Delivery Servers 78 4xx Error Rate on Delivery Servers 79 4xx Error Rate on Service Routers 79 Total Rejections due to Quota Limits 80 4xx Errors 81 Sorted Delivery Services by Client Errors on Service Routers 81 Response Codes by Protocol 82 4xx Errors by Protocol 82 Streaming 82 Sessions 83 Concurrent Active Sessions 83 Total Sessions by Protocol 83 Session Download Size 84 ABR 84 Bitrate 84 Bitrate Oscillations 85 Total Requests 85 Request Rate 86 MobiTV Client Log Analysis 87 Viewers 87 Number of Unique Viewers 88 Viewers by Client Type 88 Viewer Density by Location 88 Top Viewers 89 Viewers by Session Duration 90 Viewers by ISP, Net Speed 90 Viewers by Protocol 90 Viewers by Download Size 91 Content 91 Content by Client Requests 91 Content by Bytes Transferred 91 Top Content by Delivery Server 91 Average ABR Session Bitrate by Content 91 Top Content by City 92 Videoscape Distribution Suite Service Manager User Guide, Release 3.3 vi Contents Top Content by Client Type 92 Content Origin 92 Ingest Requests 92 Bytes Read 92 Download Speed 93 Ingest Response Codes 93 Origin Server Failures 94 Billing 94 95/5 Billing 94 Pay Go Billing 96 Reports 96 Daily 97 CDN Traffic [5 min Intervals] 97 Traffic Summary by Delivery Servers 97 Traffic Summary by Delivery Services 98 Delivery Server Traffic [5 min Intervals] 99 Delivery Service Traffic [5 min Intervals] 99 All Assets - Video 100 All Assets - Non-Video 101 Weekly 101 CDN Traffic [1 hour Intervals] 101 Traffic Summary by Delivery Servers 102 Traffic Summary by Delivery Services 103 Delivery Server Traffic [1 hour Intervals] 103 Delivery Service Traffic [1 hour Intervals] 104 All Assets - Video 105 All Assets - Non-Video 105 Monthly 105 CDN Traffic [1 day Intervals] 106 Traffic Summary by Delivery Servers 106 Traffic Summary by Delivery Services 107 Delivery Server Traffic [1 day Intervals] 108 Delivery Service Traffic [1 day Intervals] 108 All Assets - Video 109 All Assets - Non-Video 109 Videoscape Distribution Suite Service Manager User Guide, Release 3.3 vii Contents Custom Searches and Reports 110 Creating a Custom Report 111 Deleting a Custom Report 112 Custom Dashboards 112 Adding a Custom Dashboard 112 Deleting a Custom Dashboard 115 Content 115 Analyze by Content Title 115 Viewership Report 128 Sessions 129 Analyze by Client IP 129 Session Report 130 Geo Analysis 131 Cache Hit Ratio by Location 131 Viewers Density by Location 132 Bytes Delivered by City 132 Average ABR Bitrate by City 133 4xx and 5xx Errors by City 134 North Bound Application Programming Interface 134 Generating CSV Files from Search Results (Gencsvfromsearch) 136 Configuring Search File 136 Run Shell Script 139 Run Python Script 140 CHAPTER 5 Monitor 141 Monitor Overview 141 CHAPTER 6 Alerts 147 Alerts Overview 147 Adding a Threshold Alert 147 Deleting a Threshold Alert 149 Customizing Threshold Metrics 149 Quota Violations 150 Bandwidth Alerts 150 Session Alerts 151 Videoscape Distribution Suite Service Manager User Guide, Release 3.3 viii Contents Storage Alerts 151 CHAPTER 7 Configuration 153 VDS Manager Configuration 153 Multi-Tiered and Multi-Tenancy 153 Adding a CDN 154 Managing a VDS-IS CDN 155 Distribution Hierarchy Function Overview 157 Adding a Distribution Hierarchy 157 Modifying a Distribution Hierarchy 158 Cloning a Distribution Hierarchy 158 Deleting a Distribution Hierarchy 158 Delivery Servers 159 Modifying a Delivery Server 159 URL Signing 159 Creating URL Signature 162 Editing URL Signature 162 Deleting URL Signature 163 Delivery Services 164 Adding a Delivery Service 164 Deleting a Delivery Service 167 Reseller Function Overview 167 Adding a Reseller 167 Modifying a Reseller 169 Deleting a Reseller 169 Content Provider Function Overview 170 Adding a Content Provider 170 Mapping a Content Provider and Delivery Service 171 Assigning Multiple Content Providers to a Single Delivery Service 172 Modifying a Content Provider 173 Deleting a Content Provider 173 Services 174 Geo Fencing 176 Assigning a Geo/IP file to a Delivery Service 176 Disassociating a Geo/IP file from a Delivery Service 177 Videoscape Distribution Suite Service Manager User Guide, Release 3.3 ix Contents Content Purging 178 Deleting Content 178 CHAPTER 8 Administration 181 System Load Dashboard 181 License Usage 183 Managing Users and Roles Overview 184 About User Accounts 184 Roles 185 Adding a User 185 Deleting a User 186 Global Configurations 186 Adding Global Configurations 187 Deleting Global Configurations 187 CDN Health 188 Enabling Service Monitor Transaction Log 188 Enabling Service Monitor (SE) Transaction Log 188 Enabling Service Monitor (SR) Transaction Log 188 Monitor 189 CPU Usage 190 Memory Usage 191 Disk Usage 192 CPU Usage by Protocol Engines 193 Memory Usage by Protocol Engines 194 Stopped Protocol Engines 195 Threshold Exceeded Protocol Engines 196 Trend 196 Service Engine 196 CPU Usage 197 Memory Usage 198 Disk Usage 199 CPU Usage by Protocol Engines 200 Memory Usage by Protocol Engines 201 TCP Server Connections 202 TCP Client Connections 203 Videoscape Distribution Suite Service Manager User Guide, Release 3.3 x Contents Service Router 204 CPU Usage 204 Memory Usage 205 Disk Usage 206 CPU Usage for Service Routing 207 Memory Usage for Service Routing 208 TCP Server Connections 209 TCP Client Connections 210 Log Event Discrepancies 211 CHAPTER 9 Troubleshooting 213 Troubleshooting Analytics Dashboards 213 Troubleshooting Splunk Licensing Issues 214 Troubleshooting Splunk Forwarder Issues 215 Troubleshooting the Splunk Indexer 216 Troubleshooting the Analytics Search Head 217 Troubleshooting VDS-IS Provisioning 219 Deleting Summarized Data 219 Splunk License Violation 220 Videoscape Distribution Suite Service Manager User Guide, Release 3.3 xi Contents Videoscape Distribution Suite Service Manager User Guide, Release 3.3 xii Preface • Audience, page xiii • Document Conventions, page xiii • Document Organization, page xv • Reporting Problems, page xvi • Obtaining Documentation and Submitting a Service Request, page xvi Audience The Videoscape Distribution Suite Service Manager (VDS-SM) User Guide provides instructions to the Operators and Administrators, who are responsible for the management, real-time analysis and monitoring, business policy enforcement, and other critical network intelligence for Videoscape Distribution Suite Internet Streaming (VDS-IS) and other 3rd party Content Delivery Networks (CDNs). Document Conventions This document uses the following conventions: Table 1: Document Conventions Convention Description ^ or Ctrl Both symbols represent the Control (Ctrl) key on the keyboard. For example, the key combinations ^D or Ctrl-D means that you hold down the Control key while you press D . (Keys are indicated in capital letters but are not case sensitive.) bold font Commands, keywords, and user-entered text appear in bold font. Italic font Document titles, new or emphasized terms, and arguments for which you need to enter values appear in italic font. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 xiii Preface Document Conventions Convention Description Courier font Terminal sessions and information, which the system displays appear in courier font. Bold Courier font Bold Courier font indicates the text that you must enter. [x] Elements in square brackets are optional. ... An ellipsis (three consecutive non-bolded periods without spaces) after a syntax element indicates that the element can be repeated. | A vertical line, called a pipe, indicates a choice within a set of keywords or arguments. [x | y] Optional alternative keywords are grouped in brackets and separated by vertical bars. {x | y} Required alternative keywords are grouped in braces and separated by vertical bars. [x {y | z}] Nested set of square brackets or braces indicate optional or required choices within optional or required elements. Braces and a vertical bar within square brackets indicate a required choice within an optional element. string A non-quoted set of characters. Do not use quotation marks around the string or the string will include the quotation marks. <> Nonprinting characters such as passwords appear in angle brackets. [] Default responses to system prompts appear in square brackets. !, # An exclamation point (!) or a pound sign (#) at the beginning of a line of code indicates a comment line. Reader Alert Conventions This document uses the following conventions for reader alerts: Note Tip Means reader take note. Notes contain helpful suggestions or references to material, which is not covered in the manual. Means the following information will help you solve a problem. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 xiv Preface Document Organization Caution Timesaver Warning Means reader needs to be careful. In this situation, you might do something that could result in equipment damage or loss of data. Means the described action saves time. You can save time by performing the action described in the paragraph. Means reader beware. In this situation, you might perform an action that could result in bodily injury. Document Organization This document is organized into the following chapters: Table 2: Document Organization Chapter Description Getting Started Provides information on getting started with VDS-SM 3.3. Introduction to VDS-SM Portal's Describes the VDS-SM user interface and general framework. User Interface Home Displays various scorecards such as Network, Protocol, Content, Viewers, and Content Origin. Analytics Displays various dashboards such as Analyze Metrics with Pivoting, Trends, Reports, and Geo Analysis. Monitor Displays various dashboards such as Throughput, Cache Hit Ratio, and Responses, which helps the CDN Operators to check the performance of the network. Alerts Displays quota violations alerts which lists count of events that are generated by the system, and provides details on how to manage threshold alerts. Configuration Describes how to configure the CDN, Reseller and Content Providers. Administration Provides information on how to manage users and roles, an overview of the global configuration parameters, and dashboards to monitor the CDN health parameters. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 xv Preface Reporting Problems Reporting Problems If you have any query or experience problems when installing the VDS Service Manager software, contact your Cisco Technical representative. Obtaining Documentation and Submitting a Service Request For information on obtaining documentation, using the Cisco Bug Search Tool (BST), submitting a service request, and gathering additional information, see What's New in Cisco Product Documentation, at: http:// www.cisco.com/c/en/us/td/docs/general/whatsnew/whatsnew.html. Subscribe to What's New in Cisco Product Documentation, which lists all new and revised Cisco technical documentation as an RSS feed and delivers content directly to your desktop using a reader application. The RSS feeds are a free service. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 xvi CHAPTER 1 Getting Started • Getting Started, page 1 • Configuring Videoscape Distribution Suite Service Manager , page 2 • Configuring CSV Files, page 3 • Configuring VDS-IS for VDS-SM, page 4 • Verifying Log Ingestion in VDS-SM, page 11 • Verifying Connectivity Between VDS-IS and VDS-SM, page 11 • Checking for Data in VDS-SM, page 12 Getting Started The VDS-SM provides configuration, management, real-time analytics and monitoring, business policy enforcement, and other critical network intelligence for VDS-IS. The solution installs on a VM infrastructure and operates on a customer's traditional computing system or a Cisco UCS system. This allows more efficient and focused use of computing resources, memory, and disk space; thus resulting in a more efficient ratio of computing resources to application performance. Before you begin, ensure that the following tasks are completed as part of installation: • Run configure indexers script. For details, see the section Adding an Analytics Indexer to VDS-SM, in the Software Installation Guide. If VDS-SM cluster setup is installed, see the section Adding an Analytics Indexer to VDS-SM Cluster, in the Software Installation Guide. • Schedule getCDStopology script in cron (for details, see the section Deploying CDS System Delivery Server/Services in Analytics Node in the Software Installation Guide). • Add the Splunk license. To add the Splunk license, perform the following steps: 1 Copy the Splunk license file to your local machine, taking care to note the location, which will be used later in this procedure. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 1 Getting Started Configuring Videoscape Distribution Suite Service Manager 2 Open the Splunk manager app in the Job Scheduler. Example, http://<IP of Job Scheduler>:8000/en-us/manager (Username: Admin or admin Password: Beaumaris1). Note Do not change the above mentioned Splunk credentials. In the Change Password dialog box, click Skip and proceed. 3 Select Licensing. 4 Select Add License. 5 Browse your machine to the location where you copied the license file. 6 Select Install. 7 Return to the Licensing page and confirm whether the new license is added and is valid. Note Do not change the Splunk license filename. Configuring Videoscape Distribution Suite Service Manager VDS-SM discovers topology of Content Delivery Network (Service Engine, Service Router, and Distribution Hierarchy) and Delivery Services through CDSM. To initiate the discovery, you need to register the CDSM IP address along with the user credentials that is required to connect to CDSM. To configure VDS-SM, perform the following steps: Step 1 Login to VDS-SM using the link http://UInode IP/bnimgmt Username: bniadmin and Password: admin Step 2 From the main page, choose Configuration > CDN. To add CDN, see Adding a CDN, on page 154 Synchronization between VDS-SM and CDSM occurs at an interval of five minutes. After synchronization, the status will be displayed as ‘Synchronization Successful’. After synchronization, you can select the CDN and verify whether the devices and services information have been discovered. Note Only Distribution Hierarchy and Delivery Services can be added or modified in VDS-SM. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 2 Getting Started Configuring CSV Files Configuring CSV Files VDS-SM uses CSV files to map certain attributes with the log events. These CSV files need to be configured optionally for filters and for certain dashlets to be reflected in the user interface. The CSV files are located in the Job Scheduler node at the following location (Username: bnisplunk and Password: password): /opt/splunk/etc/deployment-apps/appnormalize/lookups delivery_server_capacity.csv This CSV file is used to enter the Bandwidth Capacity and Storage Capacity values for the Delivery Server that is being used. These values will be reflected in Throughput and Storage Capacity dashlets (these charts are available in Network scorecard and Trends). provider_title.csv This CSV file is used to map the Filename of the content played with its Title, Resolution, and Genre. These values will be mapped under the respective filters in the Content scorecard. useragent_device.csv This CSV file is used to map the user agent by which the content is played to its meaningful name (user defined). These values will be reflected in the Top Content by Client Type dashlet (this chart is available in Viewers scorecard and Trends). However, if this CSV is not updated manually, the dashlet will be displayed by fetching the actual user agent of the client. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 3 Getting Started Configuring VDS-IS for VDS-SM Configuring VDS-IS for VDS-SM VDS-SM uses transaction logs that are generated by Service Router (SR) and Service Engine (SE) for analysis. Therefore, you need to configure SR and SE to enable logging and export them to VDS-SM. Important We recommend you to use the following versions of VDS-IS: • VDS-IS 3.3.1 • VDS-IS 4.0.0 • VDS-IS 4.1.1 Enabling Transaction Log To enable and export transaction logs, perform the following steps: Step 1 Step 2 Login to the CDSM UI. Click Devices and select the required SE. Step 3 In the right pane, choose Service Control > Transaction Logging. Step 4 Check the Transaction Log Enable check box. Step 5 From the Log File Format drop-down list, choose custom format for CDNM option. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 4 Getting Started Enabling Transaction Log Step 6 From within Archive Settings, click every radio button and set the archive to 5 minutes (300 seconds). Note VDS-SM recommends that the archival time be set to 5 minutes. Exceeding this time interval would result in missing events (logs), which might hinder the dashboards from being populated. Step 7 From within Splunk UF Export Settings (scroll down using the scroll bar), check the Export Enable check box, and check the type of logs that has to be logged (Snapshot Counter, FMS, Web Engine, ABR Session, WMT). Videoscape Distribution Suite Service Manager User Guide, Release 3.3 5 Getting Started Enabling Transaction Log Step 8 Enter the VDS-SM Forwarder IP in the Export Server field and click Submit. The following steps are necessary to populate the network scorecards and other SR related dashlets in VDS-SM. Step 9 Select Devices and select the required SR. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 6 Getting Started Enabling Transaction Log Step 10 In the right pane, choose General Settings > Notification and Tracking > Transaction Logging. Step 11 From within Archive Settings, click every radio button and set the archive to 5 minutes (300 seconds). Step 12 From within Splunk UF Export Settings (scroll down using the scroll bar), check the Export Enable check box, and check the type of logs that has to be logged (Snapshot Counter and Service Router). Videoscape Distribution Suite Service Manager User Guide, Release 3.3 7 Getting Started Enabling Session Tracking for ABR Services Enabling Session Tracking for ABR Services VDS-SM uses ABR session logs to analyze ABR sessions. Although the ABR session log is enabled as part of the previous step, the log will be generated only if session tracking is configured for the delivery services. You can configure session tracking using CDSM as mentioned below: 1 Choose Services and select the required delivery service. 2 In the left pane, choose Location settings and enable the required protocol (HSS, HLS, and generic session tracking). For more information, refer General Settings Fields table (page 257) in the VDS-IS Software Configuration Guide (http://www.cisco.com/c/en/us/td/docs/video/cds/cda/is/4_1/configuration-guide/SCG1.pdf) CAVEAT: With VDS-IS, session tracking is supported only by SE at the edges. If SE from inner tiers are used to deliver content, then session tracking cannot be enabled on those SEs and the sessions will not be visible to VDS-SM. Valid Rule File A valid rule file must be present in CDSM to analyze the ABR protocols and bitrate fields. Choose System > Configuration > Authorization File Registration (in the right pane). Videoscape Distribution Suite Service Manager User Guide, Release 3.3 8 Getting Started Securing log transfer between VDS-IS and VDS-SM Example The following are rule file entries with fields for analyzing the ABR protocols: <Rule_Allow matchGroup="grp1" protocol="http"/> <Rule_SetAction name="Rule_DSConfig" matchGroup="grp1" protocol="http"> <SetParameter name="SessionResolveRule#1" value="(.*)m3u8(.*):none"/> //m3u8 is the extension of the video played <SetParameter name="GenericSessionPlay#1" value="(.*)ts(.*):none"/> <SetParameter name="SessionProtocol#1" value="(.*):protocol=$generic_hls"/> //to map abr-protocol field from the log <SetParameter name="SessionBitrate#1" value="(.*)sample/(.*)/(.*):bitrate=$2"/> //to map the bit rate fieldfrom the field <SetParameter name="SessionProfile#1" value="(.*)sample/(.*)/(.*):profile=$2"/> //HDS <SetParameter name="SessionResolveRule#1" value="(.*)f4m(.*):none"/> <SetParameter name="SessionProtocol#1" value="(.*)f4m|f4v|Frag(.*):protocol:HDS"/> <SetParameter name="SessionBitrate#1" value="/sample1_(.*)kbps:bitrate=$1"/> <SetParameter name="SessionProfile#1" value="/sample1_(.*)kbps/:profile=$1"/> The following are sample log file entries that are mapped using the above rule file entries: #Software: (CDS 3.2.0 b8) client-ip abr-protocol session-id manifest-uri asset-id bytes-sent bytes-recvd status time-recvd time-to-serve bitrate encryption session-tracking-mode status-code user-agent entry-gen-time mime-type profile 10.140.8.240 generic_hls 10f-I-617F44E4B4027469A848025065C227409629 http://hls.abr.com/sample/sample.m3u8 - 514515 1663 bitrate_shift [10/Jan/2013:05:52:53.710+0000] Note Make sure that proper quotas (Storage, Bandwidth, Session) are being allotted to Delivery Services in CDSM. Securing log transfer between VDS-IS and VDS-SM The logs generated during content distribution are transferred from VDS-IS to VDS-SM for analytics through TCP. The Splunk Universal Forwarder (UF)monitors the log files and forwards the events to VDS-SM in real-time. The Lightweight Forwarder (LWF) present in VDS-SM aggregates events from multiple sources and forwards them to Indexers. The communication between UFs (embedded in SEs and SRs) and LWF (present in VDS-SM) is not secure. However, securing sensitive raw data helps to avoid security threats. Turn on SSL encryption using either self-signed certificates or certificates signed by third Party CA. This provides encryption and compression of raw data that flows from upstream forwarders into VDS-SM. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 9 Getting Started Securing log transfer between VDS-IS and VDS-SM Note • Cisco does not recommend usage of default certificates that are shipped with Splunk. • By default secure log transfer feature will be turned off. You can turn on/off this feature as per your needs. When turning on secure transfer of log files, ensure the following: • While generating Root Certificate using openssl, do not specify common name and challenge password. • While generating Server Certificate, do not specify challenge password. • When generating Server Certificate, note the common name as you have to use it when you configure SSL on the forwarder. • While generating Client Certificate, do not specify common name and challenge password. Installing Certificates To install the certificates in VDS-SM, you need to copy the certificates to the following directory: /opt/splunkforwarder/etc/certificates/ To install the certificates in VDS-IS, refer VDS-IS User guide. Configuring Splunk for SSL To configure Splunk for SSL in VDS-SM, define the following code stanzas in inputs.conf file of the Job Scheduler node. The inputs.conf file is available in the path: $SPLUNK_HOME/etc/deployment-apps/CDN_UF/local/inputs.conf. [SSL] rootCA = $SPLUNK_HOME/etc/certificates/<root_certificate_name.pem> serverCert = $SPLUNK_HOME/etc/certificates/<server_certificate.pem> password = <server_key_password> requireClientCert = false sslVersions = <Required SSL Version> cipherSuite = <Required ecdh cipherSuite String> allowSslRenegotiation = true ecdhCurveName = <ecdh_curve_name> [splunktcp-ssl:9998] Note • In VDS-SM, the default configuration is to disable both [SSL] and [splunktcp-ssl:9998] by commenting out the lines and enabling [splunktcp://:9998]. You have to comment [splunktcp://:9998] and uncomment [SSL] & [splunktcp-ssl:9998] stanzas. • If there are no sslVersions specific requirements, then comment the sslVersions line. The default value for sslVersions is "*,-ssl2" (anything later than SSLv2). • If there are no cipherSuite specific requirements, then comment the cipherSuite line. Otherwise use the default cipher string. For VDS-IS, refer VDS-IS User guide. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 10 Getting Started Verifying Log Ingestion in VDS-SM Validating Configurations To validate the configurations on VDS-SM, perform the following steps: Step 1 Navigate to the following location: $SPLUNK_HOME/var/log/splunk/splunkd.log Step 2 In the logs, check for the following line: INFO INFO TcpInputConfig - IPv4 port 9998 is reserved for splunk 2 splunk (SSL) TcpInputConfig - IPv4 port 9998 will negotiate new-s2s protocol Verifying Log Ingestion in VDS-SM After enabling the export of log data using Splunk UF, SE and SR will connect to the VDS-SM Forwarder node and start ingesting data. You can verify the data flow in the system as mentioned in the Verifying Connectivity Between VDS-IS and VDS-SM, on page 11 section. Verifying Connectivity Between VDS-IS and VDS-SM You need to check whether the connection has been established or not between SE, SR, and the Forwarder node. To verify the connectivity between VDS-IS and VDS-SM, perform the following steps: Step 1 SSH to VDS-SM Forwarder node. Username: bnisplunk and Password: password Step 2 Enter the command netstat -na | grep 9998 Connection must be established between SE, SR, and the Forwarder node. If the connection is not established, verify the connectivity between VDS-SM Forwarder node and the nodes in CDN. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 11 Getting Started Checking for Data in VDS-SM Checking for Data in VDS-SM VDS-SM aggregates data at different intervals to compute metrics. Therefore, expect some delay for the data to reflect in the dashboards. Note All the above steps need to be performed as a prerequisite before ingesting logs into VDS-SM. The following table lists the different dashboards and the time they require to display the data: Dashboard Time Required Monitor Less than 15 minutes Network Scorecard 1 Hour Protocol Scorecard 1 Hour Content Scorecard 1 Day Viewers Scorecard 1 Day Trends 1 Day Content and Session Analytics 1 Day To check the data in VDS-SM, perform the following steps: Step 1 Login to VDS-SM using the link http://UInode IP/bnimgmt Username: bniadmin and Password: admin Step 2 Choose Analytics > Custom Searches and Reports. In the Search page, query for the respective index and check whether the data is indexed. After playing various video formats, the corresponding dashboards will be populated in VDS-SM. Monitor dashboard can be used to check the data flow into VDS-SM at real-time (with minimal delay). Videoscape Distribution Suite Service Manager User Guide, Release 3.3 12 Getting Started Checking for Data in VDS-SM Dashboard Remarks Network scorecard > 24 hours (default time) Displays data for the last 24 hours. Network Scorecard > 60 minutes Displays data for the last 60 minutes (current time minus 10 minutes). Network Scorecard > 7 days Displays data for the last 7 days. Protocol Scorecard > 60 minutes (default) Displays data for the last 60 minutes (current time minus 10 minutes). Protocol Scorecard > 24 hours Displays data for the last 24 hours. Protocol Scorecard > 7 days Displays data for the last 7 days. Content Scorecard > Previous day (default) Displays the previous day's data. Content Scorecard >7 days Displays data for the last 7 days. Viewers Scorecard > Previous day (default) Displays the previous day's data. Viewers Scorecard >7 days Displays data for the last 7 days. Monitor Displays data for every 5 minutes with 1 minute delay. Trends Displays data for last 7 days by default. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 13 Getting Started Checking for Data in VDS-SM Videoscape Distribution Suite Service Manager User Guide, Release 3.3 14 CHAPTER 2 Introduction to Videoscape Distribution Suite Service Manager Portal's User Interface • Videoscape Distribution Suite Service Manager Overview, page 15 • VDS-SM Portal's User Interface Overview, page 18 • User Interface Components, page 19 • Role Based Access Control, page 24 Videoscape Distribution Suite Service Manager Overview The VDS-SM provides configuration, management, real-time analytics and monitoring, business policy enforcement, and other critical network intelligence for VDS-IS. CDN hosts different content, such as live and archived, to viewers around the world. It helps the CDN Operators to quickly check the performance of the network. The VDS Manager software includes the following major components: • Analytics—Creates a fast searchable index of CDN streaming device log files for centralized access. • Provisioning—Provides the Administration team the rights to create new Delivery Services and to control CDN from the same interface, which is used for analytics retrieval. • Reporting—Provides a single interface for provisioning and reporting CDN solutions that may reside in a single provider’s environment (for example, VDS-IS). The application nodes that comprise the VDS-SM solution are Java applications deployed within a JBOSS application server, and is separated into distinct “solutions”, each of which provides a specific set of services for the overall application. VDS-SM Application Nodes The VDS-SM supports the following application nodes: • Core Services • User Interface Videoscape Distribution Suite Service Manager User Guide, Release 3.3 15 Introduction to Videoscape Distribution Suite Service Manager Portal's User Interface Logging Into the User Interface • CDN Manager • Analytics Core Services The Core Services node includes the following: • Management Interface—This interface provides service registry, and stores global configuration parameters, for the management of solution nodes. • Database—Hosts the MySQL database that is used to store the configuration information including topology, solution tables, and registry information. User Interface Presents a User Interface where status, configuration, and analytics can be viewed by the Operator. CDN Manager Provides management services for CDN including Cisco VDS-IS. Analytics Analytics includes the following nodes: • Search Head—Provides search and reporting functions. • Forwarder—Manages the distribution of log data from CDN to Analytics Infrastructure for processing. • Indexer—Processes log data to facilitate fast data retrieval and reporting. • Job Scheduler—Provides job scheduling and functions as a deployment repository for the analytics software. Logging Into the User Interface To log into the VDS-SM user interface, follow these steps: 1 Enter your Username and Password in the Login window. By default, the username is bniadmin and the password is admin. If required, you can change the username and password after initial log in. Note A Session Timeout popup window will be displayed if you are logging into the user interface using multiple systems or different browsers. 2 To log out of the user interface, click Logout, located on the top-right corner of the window. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 16 Introduction to Videoscape Distribution Suite Service Manager Portal's User Interface Changing Your Password Changing Your Password To change your password, click the <User Profile> button, for example, bniadmin, located in the menu bar, to open the User Info dialog box. User Info Dialog To increase security, we recommend that you use a combination of letters, numbers and characters. Alert Counter The Alert Manager, which is accessed from the Alerts function, allows you to view the recently triggered alerts. It displays records of triggered alerts. To access the Alerts function click Alerts, located in the top-right of the main page. Following is a list of alerts: • Application available–A service named in an alert has become available, meaning it has been recognized as in service by the system. • Application unavailable–A service named in an alert became unavailable, meaning it is no longer visible on the network or is out of service. • Delivery Service conflict–An alert is created when there is a conflict in the Device Service • Device In Service–A topology device has transitioned to in service and is eligible to service requests, if it is operational. • Device Out of Service–A topology device has transitioned to out of service and is not eligible to service requests, if it is operational. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 17 Introduction to Videoscape Distribution Suite Service Manager Portal's User Interface VDS-SM Portal's User Interface Overview Note Alert Counter is available only for the CDN Operators. VDS-SM Portal's User Interface Overview This section provides an overview of the VDS-SM Portal's user interface. Note Before you access the VDS-SM Portal's user interface, you must deploy, install, and configure, all nodes in your network. VDS-SM comprises the following functions: Table 3: VDS-SM Functionalities & Description Function Description Home Displays the following scorecards: • Network • Protocol • Content • Viewers • Content Origin Analytics Displays the following menus and submenus: • Analyze Metrics with Pivoting • Trends • Reports • Customs Searches and Reports • Custom Dashboards • Content–Analyze by Content Title and Viewership Report • Sessions–Analyze by Client IP and Session Report • Geo Analysis Monitor Videoscape Distribution Suite Service Manager User Guide, Release 3.3 18 Helps the CDN Operators check the performance of the network. Introduction to Videoscape Distribution Suite Service Manager Portal's User Interface User Interface Components Function Description Alerts Displays the following menus: • Thresholds • Quota Violations Configuration Displays the following menus and submenus: • CDN • Customers–Reseller and Content Provider • Services • Geo Fencing • Content Purging Administration Displays the following menus: • System Load Dashboard • License Usage • User Management • Global Configurations • CDN Health–Monitor and Trend • Log Event Discrepancies User Interface Components The user interface components are explained in the following table: Table 4: User Interface Components Component Description User Profile To change your password, click the <User Profile > button; for example, bniadmin, located in the top-right corner of the window, to open the User Info dialog box. Note Alert Counter The button name displays the name of the user logged in. Lists the alert notifications. Click Alerts, located next to User Profile. It displays the alerts you set up. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 19 Introduction to Videoscape Distribution Suite Service Manager Portal's User Interface User Interface Components Component Description About Click About, located next to Alerts, to display the About dialog box. Logout Click Logout, located next to Help, to log out from the application. Home Displays the following scorecards: • Network • Protocol • Content • Viewers • Content Origin Analytics Displays the following menus and submenus: • Analyze Metrics with Pivoting • Trends • Reports • Customs Searches and Reports • Custom Dashboards • Content–Analyze by Content Title and Viewership Report • Sessions–Analyze by Client IP and Session Report • Geo Analysis Monitor Displays the following dashlets: • CDN Overview • Throughput • Cache Hit Ratio • Concurrent Active Sessions • Responses • Bitrates Alerts Displays the following menus: • Thresholds • Quota Violations Videoscape Distribution Suite Service Manager User Guide, Release 3.3 20 Introduction to Videoscape Distribution Suite Service Manager Portal's User Interface Main Menu Component Description Configuration Displays the following menus and submenus: • CDN • Customers–Reseller and Content Provider • Services • Geo Fencing • Content Purging Administration Displays the following menus: • System Load Dashboard • License Usage • User Management • Global Configurations • CDN Health–Monitor and Trend • Log Event Discrepancies Main Menu The main menu bar displays all VDS-SM tabs. Click the menus to view the submenus. About The VDS-SM Portal's About option lists the following information: • Product Version Number • Product Name • Build Timestamp • Build Number • Build Java Version • Software Licenses • End User Licenses Agreement To access this, click About at the top right of the page. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 21 Introduction to Videoscape Distribution Suite Service Manager Portal's User Interface Configuration Icons Note Click the orange arrow next to the item to see more information. Configuration Icons VDS-SM portal provides various icons to perform configuration commands or to indicate operational status. The following table lists all the icons included in the user interface. Table 5: User Interface Icons Icon Description Go to Detail page Create or Add Delete Videoscape Distribution Suite Service Manager User Guide, Release 3.3 22 Introduction to Videoscape Distribution Suite Service Manager Portal's User Interface Configuration Icons Icon Description Undo Refresh Disable Enable Clone Import Edit: in-line mode: • Select: light gray Edit: full-screen mode: • Select: light gray Edit: bulk mode: • Select: light gray • Deselect: dark gray Edit: Item Selector Information Auto Refresh Context Sensitive Help Search; Filter Notice Normal Added Videoscape Distribution Suite Service Manager User Guide, Release 3.3 23 Introduction to Videoscape Distribution Suite Service Manager Portal's User Interface Role Based Access Control Icon Description Deleted Edited View Export Add Volumes Remove Volumes Operational State: Up Operational State: Down Synchronization Role Based Access Control Role Based Access Control (RBAC) is implemented in VDS-SM. Delivery Services and Providers drop-down lists are filtered, based on the user logged into the system. The following figure shows the permissions granted for CDN Operator Admin, CDN Operator Viewer, Reseller Admin, Reseller Viewer, Content Provider Admin, and Content Provider Viewer. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 24 Introduction to Videoscape Distribution Suite Service Manager Portal's User Interface Role Based Access Control Access privileges are determined by the role assigned to the user. A user may be granted privileges for all or some system configuration and management functions. The CDN Operator Admin and CDN Operator Viewer have access to almost all the functions in VDS-SM except for the following: • CDN Operator Admin—Reseller Profile, Content Provider Profile, Monitor (Services page). • CDN Operator Viewer—Reseller Profile, Content Provider Profile, System Load Dashboard, License Usage, User Management, Monitor (Services page). The following table lists the access privilege to Reseller Admin. Main Menu and Navigation Reseller Admin Home > Scorecards Delivery Service and Provider drop-down lists will be filtered for the Reseller. View results and Analyze data link will not be available. Analytics > Trends Delivery Service and Provider drop-down lists will be filtered for the Reseller. Analytics > Reports Delivery Service and Provider drop-down lists will be filtered for the Reseller. Analytics > Content > Analyze by Content Title Delivery Service drop-down list will be filtered for the Reseller. Analytics > Content > Viewership Report Delivery Service and Provider drop-down lists will be filtered for the Reseller. Analytics > Sessions > Analyze by Client IP Delivery Service and Provider drop-down lists will be filtered for the Reseller. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 25 Introduction to Videoscape Distribution Suite Service Manager Portal's User Interface Role Based Access Control Main Menu and Navigation Reseller Admin Analytics > Sessions > Session Report Delivery Service and Provider drop-down lists will be filtered for the Reseller. Configuration > Customers > Content Provider Displays the list of Content Providers (assigned to the Reseller) associated with the customer. A Reseller Admin can create a Content Provider and assign delivery services. Configuration > Content Purging Only the content deletion tasks will be displayed for the Reseller Admin. Administration > User Management Delivery Service and Provider drop-down lists will be filtered for the Reseller. A Reseller Admin has the privilege to create a Reseller Viewer, Content Provider Admin, and Content Provider Viewer roles. Monitor > Monitor (Services page) The data displayed in the screen is filtered, based on the logged in user. The following table lists the access privilege to Reseller Viewer. Main Menu and Navigation Reseller Viewer Home > Scorecards Delivery Service and Provider drop-down lists will be filtered for the Reseller. View results and Analyze data link will not be available. Analytics > Trends Delivery Service and Provider drop-down lists will be filtered for the Reseller. Analytics > Reports Delivery Service and Provider drop-down lists will be filtered for the Reseller. Analytics > Content > Analyze by Content Title Delivery Service drop-down list will be filtered for the Reseller. Analytics > Content > Viewership Report Delivery Service and Provider drop-down lists will be filtered for the Reseller. Analytics > Sessions > Analyze by Client IP Delivery Service and Provider drop-down lists will be filtered for the Reseller. Analytics > Sessions > Session Report Delivery Service and Provider drop-down lists will be filtered for the Reseller. Configuration > Customers > Content Provider Displays the list of Content Providers (assigned to the Reseller) associated with the customer. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 26 Introduction to Videoscape Distribution Suite Service Manager Portal's User Interface Role Based Access Control Main Menu and Navigation Reseller Viewer Configuration > Content Purging Only the content deletion tasks will be displayed for the Reseller Viewer. Monitor > Monitor (Services page) The data displayed in the screen is filtered, based on the logged in user. The following table lists the access privilege to Content Provider Admin. Main Menu and Navigation Content Provider Admin Home > Scorecards Delivery Service and Provider drop-down lists will be filtered for the Content Provider. View results and Analyze data link will not be available. Analytics > Trends Data will be filtered for the respective Content Provider. Analytics > Reports Data will be filtered for the respective Content Provider. Analytics > Content > Analyze by Content Title Delivery Service drop-down list will be filtered for the respective Content Provider. Analytics > Content > Viewership Report Delivery Service and Provider drop-down lists will be filtered for the respective Content Provider. Analytics > Sessions > Analyze by Client IP Delivery Service and Provider drop-down lists will be filtered for the respective Content Provider. Analytics > Sessions > Session Report Delivery Service and Provider drop-down lists will be filtered for the respective Content Provider. Configuration > Content Purging Option to choose Delivery Server is not available. Content Provider Admin users can delete content from Delivery Services associated to them. Configuration > Geo Fencing Delivery Service drop-down list will be filtered for the respective Content Provider. Administration > User Management Data will be filtered for the respective Content Provider. A Content Provider Admin has the Privilege to create a Content Provider Viewer role. Monitor > Monitor (Services page) The data displayed in the screen is filtered, based on the logged in user. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 27 Introduction to Videoscape Distribution Suite Service Manager Portal's User Interface Role Based Access Control The following table lists the access privilege to Content Provider Viewer. Main Menu and Navigation Content Provider Viewer Home > Scorecards Delivery Service and Provider drop-down lists will be filtered for the Content Provider. View results and Analyze data link will not be available. Note Analytics > Trends Data will be filtered for the respective Content Provider. Analytics > Reports Data will be filtered for the respective Content Provider. Analytics > Content > Analyze by Content Title Delivery Service drop-down list will be filtered for the respective Content Provider. Analytics > Content > Viewership Report Delivery Service and Provider drop-down lists will be filtered for the respective Content Provider. Analytics > Sessions > Analyze by Client IP Delivery Service and Provider drop-down lists will be filtered for the respective Content Provider. Analytics > Sessions > Session Report Delivery Service and Provider drop-down lists will be filtered for the respective Content Provider. Configuration > Content Purging Only the content deletion tasks will be displayed for the Content Provider Viewer. Monitor > Monitor (Services page) The data displayed in the screen is filtered, based on the logged in user. The delivery server and delivery server group filters are not available for the wholesale users. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 28 CHAPTER 3 Home • Home Overview, page 29 • Network, page 32 • Protocol, page 38 • Content, page 45 • Viewers, page 51 • Content Origin, page 57 Home Overview The logs from VDS-IS are summarized and indexed in VDS-SM. The enormous information present in logs are displayed in charts to help the operators understand their CDN network. This provides an holistic view of a CDN. On logging into the application, the Home page is displayed. It includes various scorecards. A scorecard is a dashboard, which displays specific information about network, protocol, content, viewers, and content origin data of managed CDN. Home tab includes the following scorecards: • Network • Protocol • Content • Viewers • Content Origin Using the Scorecards Using the scorecards, you can: Videoscape Distribution Suite Service Manager User Guide, Release 3.3 29 Home Using the Scorecards • Mouse hover a specific point within a chart, which displays additional information such as time and parameters. • View results Each chart provides access to view the log information corresponding to the dashlets. Click View results, located at the bottom left of each chart, to view the report. From within the source report, you can choose a desired row to display the log details for the item. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 30 Home Using the Scorecards • Analyze data The chart in few scorecards contain data at a high-level. The CDN Operators have the option to drill down the data in the chart at a granular level. Click Analyze data, located at the bottom right of the chart, to view the details. Here, the CDN Operators can view the data plotted using various metrics over different dimensions that are split by the required dimension. You can also view the data represented in different charts, such as line, bar, area and pie, by clicking the Chart type drop-down list, which appears after you click Analyze data. Click Analyze, of, over, and split by drop-down lists and choose the required options. You can also choose the stack mode from the Stack mode drop-down list. Legend Depending on the chart, if more than one data set is displayed, a legend is located below the chart. Lookups Lookup is a process, which replaces the raw data from the logs with meaningful information. In VDS-SM, lookups are performed during summary index creation and chart rendition. CSV files and third party databases are used in the lookup operations. Following is the list of lookups: Lookup Name Description Title The raw logs has the URL field, which contains the 'asset' information. Lookup is performed on provider_title.csv file to get a meaningful Title name. This lookup is performed during summarization. Genre, The raw logs do not contain any information on Genre and Resolution. Based on 'asset', the Resolution Genre and Resolution are looked up from provider_title.csv file. This lookup is performed during summarization. Bitrate The ABR traffic type's (HLS, HDS and MobiTV) raw logs have 'profile name' to indicate bitrate. Lookup is performed on profilename_bitrate.csv to get the related bitrates for profile names. This lookup is performed during summarization. ISP, Net Sped The raw logs do not contain information on ISP and Net Speed. It has ClientIP. Lookup is performed on Maxmind DB using ClientIP to get ISP and Net Speed. The Lookup works for public IP addresses. This lookup is performed during summarization. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 31 Home Network Lookup Name Description City The raw logs do not contain the City information. It has ClientIP. Lookup is performed on Maxmind DB using ClientIP to get City. The Lookup works for public IP addresses. This lookup is performed during chart rendition. Client Type The raw logs has User Agent related information. Lookup is performed on useragent_device.csv file using User Agent to get Client Type. This lookup is performed during summarization. Capacity The Bandwidth and Storage capacity of Delivery Servers are maintained in the delivery_server_capacity.csv file. These capacity values are looked up and added to the summary indexes during summarization. Provider When CP lookup is implemented, users extract CP ID from the URL. Lookup is performed on content_provider.csv file using CP ID to get CP name. This lookup is performed during summarization. Server Lookup is performed on the origin_server_topology.csv file to manage content origin dashboards. Topology This lookup is performed during summarization. Network When you launch the application, by default, the Network tab is displayed in the Home page. This scorecard displays charts that provides the users a quick overview on the overall performance of the network. By default, the data for the last 24 hours is displayed in the scorecard. The following metrics are displayed here: • Throughput (Gbps) • Concurrent Active Sessions • Cache Hit Ratio • Response Status Codes • Storage Usage Note The Delivery Server Group filter grouping is based on the node locations. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 32 Home Throughput Throughput The following table describes the chart within this scorecard: Table 6: Throughput Chart & Description Note Chart Description Throughput (Gbps) Illustrates the bandwidth delivered by the network, for the specified time interval. Chart Information The information within this chart is shown in a line graph with Date/Time along the X-axis and Peak Throughput, Average Throughput, and Capacity in Gbps along the Y-axis. The legends are Peak, Average, and Capacity. Chart Formula The formula used to derive the peak and average throughput graph is: the maximum and mean throughput for the specified time interval. Chart Filters This chart uses Time Range (Last 60 Minutes, Last 24 Hours, and Last 7 days), Delivery Server Group, Delivery Server, Provider, and Delivery Service as filters. If requests are made directly to the service engine without the service router, this dashlet will not be displayed. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 33 Home Concurrent Active Sessions Concurrent Active Sessions The following table describes the chart within this scorecard: Table 7: Concurrent Active Sessions Chart & Description Chart Description Concurrent Active Sessions Illustrates the concurrent active sessions, for the specified time interval. Chart Information The information within this chart is a line graph with Date/Time along the X-axis and the Peak and Average Count along the Y-axis. The legends representing the graph are Peak and Average. Chart Formula The formula used to derive the graph is: calculate the maximum and mean active sessions, for the specified time interval. Chart Filters This chart uses Time Range (Last 60 Minutes, Last 24 Hours, and Last 7 days), Delivery Server Group, Delivery Server, Provider, and Delivery Service as filters. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 34 Home Cache Hit Ratio Note If requests are made directly to service engine without service router, this dashlet will not be populated. Cache Hit Ratio The following table describes the chart within this scorecard: Table 8: Cache Hit Ratio Chart & Description Chart Description Cache Hit Ratio Provides client request cache hit and miss percentage, for the specified time interval. Chart Information The information within this chart is shown in a stacked area graph with Date/Time along the X-axis and the cache hit and miss percentage in the Y-axis. The legends representing the graph are Cache Hit and Cache Miss. Chart Formula The formula used to derive the cache hit graph is: the percentage of cache hit over total requests. The formula used to derive the cache miss graph is: the percentage of cache miss over total requests. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 35 Home Response Status Codes Chart Description Chart Filters This chart uses Time Range (Last 60 Minutes, Last 24 Hours, and Last 7 days), Delivery Server Group, Delivery Server, Provider, and Delivery Service as filters. Response Status Codes The following table describes the chart within this scorecard: Table 9: Response Status Codes Chart & Description Chart Description Response Status Codes Provides response codes count and percentage, for the specified time interval. Chart Information The information within this chart is shown in stacked area with Date/Time along the X-axis with the response count and percentage along the Y-axis. The legends representing the graph are 2xx, 3xx, 4xx, and 5xx. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 36 Home Storage Usage Chart Description Chart Formula The status code from logs are grouped as 2xx, 3xx, 4xx, and 5xx. The count of each group is calculated as the sum of individual status code counts. The percentage of each group is derived by calculating the percentage of group count over total responses. Chart Filters This chart uses Time Range (Last 60 Minutes, Last 24 Hours, and Last 7 days), Delivery Server Group, Delivery Server, Provider, and Delivery Service as filters. To view the response status code in percentage and count, click the respective radio buttons located above the chart. Storage Usage The following table describes the chart within this scorecard: Videoscape Distribution Suite Service Manager User Guide, Release 3.3 37 Home Protocol Table 10: Storage Usage Chart & Description Chart Description Storage Usage Illustrates the storage usage for the specified time interval. Chart Information The information within this chart is shown in a stacked area graph with the Date/Time along the X-axis and the storage usage as Prepositioned, Dynamic, and Available in GB along the Y-axis. The legends representing the graph are Prepositioned, Dynamic, and Available. Chart Formula The prepositioned and dynamic values are derived by calculating the average of prepositioned and dynamic data, for the specified time interval. The available capacity is derived by calculating the difference between the storage capacity (as specified in the delivery_server_capacity.csv file) and the sum of prepositioned plus dynamic data. Chart Filters This chart uses Time Range (Last 60 Minutes, Last 24 Hours, and Last 7 days), Delivery Server Group, Delivery Server, Provider, and Delivery Service as filters. Protocol This tab displays charts that provides an overview of the network at the protocol level. By default, the data for the last 60 minutes is displayed in the scorecard. To access this tab, choose Home > Protocol. The following metrics are displayed here: • Volume Delivered by Protocol • Total Requests by Protocol • Response Codes by Protocol • Cache Hit Ratio by Protocol • ABR Session Bitrate by Protocol • 4xx Errors by Protocol Videoscape Distribution Suite Service Manager User Guide, Release 3.3 38 Home Volume Delivered by Protocol Volume Delivered by Protocol The following table describes the chart within this scorecard: Table 11: Volume Delivered by Protocol Chart & Description Chart Description Volume Delivered by Protocol Illustrates the volume delivered by each protocol, for the specified time interval. Chart Information The information within this chart is shown in a stacked area graph with Date/Time along the X-axis and the volume delivered in GB along the Y-axis. The legends representing the graph are protocols. Chart Formula The formula used to derive the graph is: Total of CacheMissBytes, CacheHitBytes, and NoCacheCodeBytes grouped by Protocol. Chart Filters This chart uses Time Range (Last 60 Minutes, Last 24 Hours, and Last 7 days), Delivery Server Group, Delivery Server, Provider, and Delivery Service as filters. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 39 Home Total Requests by Protocol Total Requests by Protocol The following table describes the chart within this scorecard: Table 12: Total Requests by Protocol Chart & Description Chart Description Total Requests by Protocol Illustrates the number of requests received from each protocol, for the specified time interval. Chart Information The information within this chart is shown in a stacked area graph with Date/Time along the X-axis and the request Count along the Y-axis. The legends representing the graph are protocols. Chart Formula The formula used to derive the graph is: Total Requests is the sum of all Status Code Counts grouped by Protocol. Chart Filters This chart uses Time Range (Last 60 Minutes, Last 24 Hours, and Last 7 days), Delivery Server Group, Delivery Server, Provider, and Delivery Service as filters. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 40 Home Response Codes by Protocol Response Codes by Protocol The following table describes the chart within this scorecard: Table 13: Response Codes by Protocol Chart & Description Chart Description Response Codes by Protocol Illustrates the response codes for each protocol. Chart Information The information within this chart is a stacked bar graph with Count along the X-axis and Protocol along the Y-axis. The legends represent individual response codes. Chart Formula The formula used to derive the line graphs is: the count of individual response codes grouped by the response code and protocol. Chart Filters This chart uses Time Range (Last 60 Minutes, Last 24 Hours, and Last 7 days), Delivery Server Group, Delivery Server, Provider, and Delivery Service as filters. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 41 Home Cache Hit Ratio by Protocol Cache Hit Ratio by Protocol The following table describes the chart within this scorecard: Table 14: Cache Hit Ratio by Protocol Chart & Description Chart Description Cache Hit Ratio by Protocol Illustrates the cache hit ratio for each protocol, for the specified time interval. Chart Information The information within this chart is shown in a line graph with Date/Time along the X-axis and cache hit ratio (%) along the Y-axis. The legends representing the graph are protocols. Chart Formula The formula used to derive the graph is: the percentage of cache hit over total requests grouped by the protocol. Chart Filters This chart uses Time Range (Last 60 Minutes, Last 24 Hours, and Last 7 days), Delivery Server Group, Delivery Server, Provider, and Delivery Service as filters. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 42 Home ABR Session Bitrate by Protocol ABR Session Bitrate by Protocol The following table describes the chart within this scorecard: Table 15: ABR Session Bitrate by Protocol Chart & Description Chart Description ABR Session Bitrate by Protocol Provides HSS (HTTP smooth streaming), HLS (HTTP live streaming), HDS (HTTP Dynamic Streaming) and MobiTV average bitrate (Kbps). Click the Protocol drop-down list and select the respective protocol to choose HSS, HLS, HDS, and MobiTV. Chart Information The information within this chart is shown in a line graph with Date/Time along the X-axis and maximum, minimum, and average bitrate (Kbps) along the Y-axis. The legends representing the graph are maximum, minimum, and average. Chart Formula The formula used to derive the line graphs is: calculate the maximum, minimum, and average of bitrate, for the specified time interval. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 43 Home 4xx Errors by Protocol Chart Description Chart Filters This chart uses Time Range (Last 60 Minutes, Last 24 Hours, and Last 7 days), Delivery Server Group, Delivery Server, Provider, and Delivery Service as filters. 4xx Errors by Protocol The following table describes the chart within this scorecard: Table 16: 4xx Errors by Protocol Chart & Description Chart Description 4xx Errors by Protocol Illustrates the number of 4xx errors for each protocol, for the specified time interval. Chart Information The information within this chart is shown in a stacked area graph with the Date/Time along the X-axis and the Error Count along the Y-axis. The legends representing the graph are protocol types. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 44 Home Content Chart Description Chart Formula The formula used to derive the graphs is: the count of 4xx errors in each protocol, for the specified time interval. Chart Filters This chart uses Time Range (Last 60 Minutes, Last 24 Hours, and Last 7 days), Delivery Server Group, Delivery Server, Provider, and Delivery Service as filters. Content This tab displays charts that provides an overview of the top content, based on different dimensions such as content by client request, bytes transferred, and average ABR session bitrate. By default, the data for the previous day is displayed in the scorecard. To access this tab, click Home > Content. The following metrics are displayed here: • Content by Client Request • Content by Bytes Transferred • Average ABR Session Bitrate by Content • Top Content by Delivery Server • Top Content by City • Top Content by Client Type Content by Client Request Videoscape Distribution Suite Service Manager User Guide, Release 3.3 45 Home Content by Bytes Transferred The following table describes the chart within this scorecard: Table 17: Content by Client Request Chart & Description Chart Description Content by Client Request Illustrates the most/least popular content, based on the number of client requests received. Chart Information The information within this chart is shown in a bar graph with Count along the X-axis and Title along the Y-axis. Chart Formula The formula used to derive the graph is the most/least viewed content titles by client session count, per day. Chart Filters This chart uses Time Range (Previous day and Last 7 days), Delivery Server Group, Delivery Server, Provider, Service Type (Live and VOD), Delivery Service, Resolution (HD and SD), and Genre as filters. To view the top 10 content by client request and the bottom 10 content by client request, click the respective radio buttons located above the chart. Content by Bytes Transferred The following table describes the chart within this scorecard: Videoscape Distribution Suite Service Manager User Guide, Release 3.3 46 Home Average ABR Session Bitrate by Content Table 18: Content by Bytes Transferred Chart & Description Note Chart Description Content by Bytes Transferred Illustrates the most/least popular content, based on the download size. Chart Information The information within this chart is shown in a bar graph as MB along the X-axis and Title along the Y-axis. Chart Formula The formula used to derive the graph is the most/least viewed content titles by bytes transferred to clients, per day. Chart Filters This chart uses Time Range (Previous day and Last 7 days), Delivery Server Group, Delivery Server, Provider, Service Type (Live and VOD), Delivery Service, Resolution (HD and SD), and Genre as filters. To view the top 10 content by bytes transferred and the bottom 10 content by bytes transferred, click the respective radio buttons located above the chart. Average ABR Session Bitrate by Content The following table describes the information in the tabular column: Videoscape Distribution Suite Service Manager User Guide, Release 3.3 47 Home Top Content by Delivery Server Table 19: Average ABR Session Bitrate by Content Table & Description Note Table Description Average ABR Session Bitrate by Content Illustrates the content delivered with highest/lowest bitrate. Table Information The information within this table are Title and Average Bitrate. Formula The formula used is: the top/bottom content title by average bitrate. Filters This table uses Time Range (Previous day and Last 7 days), Delivery Server Group, Delivery Server, Provider, Service Type (Live and VOD), Delivery Service, Resolution (HD and SD), and Genre as filters. To view the top 10 average ABR session bitrate by content and the bottom 10 average ABR session bitrate by content, click the respective radio buttons located above the table. Top Content by Delivery Server The following table describes the information in the tabular column: Table 20: Top Content by Delivery Server Table & Description Table Description Top Content by Delivery Server Illustrates the most popular content served by each delivery server. Table Information The information within this table are Delivery Server, Title, and Count. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 48 Home Top Content by City Table Description Formula The formula used is: the top content title (based on count) by delivery server. Filters This table uses Time Range (Previous day and Last 7 days), Delivery Server Group, Delivery Server, Provider, Service Type (Live and VOD), Delivery Service, Resolution (HD and SD), and Genre as filters. Top Content by City The following table describes the information in the tabular column: Table 21: Top Content by City Table & Description Table Description Top Content by City Illustrates the most popular content viewed in a city. Table Information The information within this table are City, Title, and Count. Formula The formula used is: the top content title (based on count) by city. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 49 Home Top Content by Client Type Table Description Filters This table uses Time Range (Previous day and Last 7 days), Delivery Server Group, Delivery Server, Provider, Service Type (Live and VOD), Delivery Service, Resolution (HD and SD), and Genre as filters. To view the list of viewers accessing ISP and Net Speed network, click the respective radio buttons located above the chart. Note The city will be resolved only for public IPs. IPs which cannot be resolved by MaxMind will not be displayed. Top Content by Client Type The following table describes the information in the tabular column: Table 22: Top Content by Client Type Table & Description Table Description Top Content by Client Type Illustrates the most popular content viewed in each client (players and browsers that is used to request the content). Table Information The information within this table are Client Type, Title, and Count. Formula The formula used is: the top content title (based on count) by client type. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 50 Home Viewers Table Description Filters This table uses Time Range (Previous day and Last 7 days), Delivery Server Group, Delivery Server, Provider, Service Type (Live and VOD), Delivery Service, Resolution (HD and SD), and Genre as filters. Viewers This tab displays charts that explains the viewer density, based on different parameters such as city, ISP, Net speed, session duration, and download size. By default, the data for the previous day is displayed in the scorecard. To access this tab, choose Home > Viewers. The following metrics are displayed here: • Unique Viewers • Viewers by Client Type • Viewers by City • Viewers by ISP and Net Speed • Viewers by Download Size • Viewers by Session Duration Videoscape Distribution Suite Service Manager User Guide, Release 3.3 51 Home Unique Viewers Unique Viewers The following table describes the chart within this scorecard: Table 23: Unique Viewers Chart & Description Table Description Unique Viewers Illustrates the number of unique viewers per day. Chart Information The information within this chart is shown in a column graph with the Date/Time along the X-axis and the unique viewer Count along the Y-axis. Formula The formula used to derive the graph is the total unique viewer, per day. Filters This chart uses Time Range (Previous Day and Last 7 Days), Delivery Server Group, Delivery Server, Provider, Delivery Service, and Media Format as filters. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 52 Home Viewers by Client Type Viewers by Client Type The following table describes the information in the tabular column: Table 24: Viewers by Client Type Table & Description Table Description Viewers by Client Type Illustrates the number of viewers accessing the network through each client. Table Information The information within this table are Client Type and Count. Formula The formula used is: unique viewer by client type and request count. Filters This table uses Time Range (Previous Day and Last 7 Days), Delivery Server Group, Delivery Server, Provider, Delivery Service, and Media Format as filters. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 53 Home Viewers by City Viewers by City The following table describes the information in the tabular column: Table 25: Viewers by City Table & Description Table Description Viewers by City Illustrates the number of viewers accessing the network in each city. Table Information The information within this table are City and Count. Note Viewers by city count appears in descending order of views. The formula used is: the number of unique viewers in each city. Formula Filters Note The city will be resolved only for public IPs. IPs which cannot be resolved by MaxMind will not be displayed. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 54 This table uses Time Range (Previous Day and Last 7 Days), Delivery Server Group, Delivery Server, Provider, Delivery Service, and Media Format as filters. Home Viewers by ISP and Net Speed Viewers by ISP and Net Speed The following table describes the information in the tabular column: Table 26: Viewers by ISP and Net Speed Table & Description Table Description Viewers by ISP and Net Speed Illustrates the number of viewers accessing the network, grouped by Internet Service Provider (ISP) or Net Speed. Table Information The information within this table are ISP or Net Speed and Count. The ISP and Net Speed count appear in descending order of views. The formula used is: the number of unique viewers grouped by client ISP or Net Speed. Note Formula Filters This table uses Time Range (Previous Day and Last 7 Days), Delivery Server Group, Delivery Server, Provider, Delivery Service, and Media Format as filters. To view the list of viewers accessing ISP and Net Speed network, click the respective radio buttons located above the table. Note Other than public IPs, "unknown" value will be displayed. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 55 Home Viewers by Download Size Viewers by Download Size The following table describes the information in the tabular column: Table 27: Viewers by Download Size Table & Description Table Description Viewers by Download Size Illustrates the number of viewers, based on the download size. Table Information The information within this table are Download Size and Count. Formula The formula used is: the number of viewers bucketed by the download size in MB. Filters This table uses Time Range (Previous Day and Last 7 Days), Delivery Server Group, Delivery Server, Provider, Delivery Service, and Media Format as filters. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 56 Home Viewers by Session Duration Viewers by Session Duration The following table describes the information in the tabular column: Table 28: Viewers by Session Duration Table & Description Table Description Viewers by Session Duration Illustrates the number of viewers, based on session duration. Table Information The information within this table are Average Session Duration (minutes) and Count. Formula The formula used is: the number of unique viewers bucketed by the average session duration. Filters This table uses Time Range (Previous Day and Last 7 Days), Delivery Server Group, Delivery Server, Provider, Delivery Service, and Media Format as filters. Content Origin In VDS-IS, the ingest transaction logs are used to log details of every request sent to the upstream SEs and origin servers. The Content Origin scorecard contains the metrics derived from the ingest transaction logs. These metrics provide insights into the interactions between Content Acquirers and Origin Servers. To access this tab, click Home > Content Origin. The following metrics are displayed here: • Ingest Requests • Origin/Ingest Volume • Bytes Read by Protocol • Download Speed Videoscape Distribution Suite Service Manager User Guide, Release 3.3 57 Home Enabling Ingest Transaction Log • Ingest Response Codes • Origin Server Failures Enabling Ingest Transaction Log Content Origin charts will be displayed only when the Ingest transaction log is forwarded from VDS-IS to VDS-SM. To enable and export Ingest transaction log, perform the following steps: Note You can perform the below steps only if you have installed VDS-IS version that supports Ingest log functionality. Step 1 Step 2 Login to the CDSM UI. Click Devices and select the required Service Engine. Step 3 In the right pane, choose Service Control > Transaction Logging. Step 4 From Monitors table, check the WMT Ingest and Web Engine Ingest check box. Step 5 Click Submit. Ingest Requests The following table describes the chart within this dashlet: Table 29: Ingest Requests Chart & Description Chart Description Ingest Requests Illustrates the total number of requests (cache miss and revalidation) sent to origin server(s), for the specified time interval.. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 58 Home Origin/Ingest Volume Note Chart Description Chart Information The information within this chart is shown in a column graph with Date/Time along the X-axis and ingest request Count along the Y-axis. Formula The formula used to derive the graph is: Count of ingest requests from the content acquirer for the given time frame. Chart Filters This chart uses Time Range, Origin Server, and Content Acquirer as filters. Revalidation-Request field is not applicable to WMT ingest logs. Origin/Ingest Volume The following table describes the chart within this scorecard: Table 30: Origin/Ingest Volume Chart & Description Chart Description Origin/Ingest Volume Illustrates the comparison between Origin and Edge Volume, for the specified time interval. Origin Volume is the bytes read from the Origin Server(s). Videoscape Distribution Suite Service Manager User Guide, Release 3.3 59 Home Bytes Read by Protocol Chart Description Chart Information The information within this chart is a line graph with Date/Time along the X-axis and the Origin and Edge Volume in GB along the Y-axis. Chart Formula The formulae used to derive the graph are: Origin—Total bytes read from Origin Server(s). Edge—Total bytes delivered from edge SEs. Chart Filters This chart uses Time Range, Origin Server, and Content Acquirer as filters. Note The Edge is unaffected by Origin Server and Content Acquirer filters. Bytes Read by Protocol The following table describes the chart within this dashlet: Table 31: Bytes Read by Protocol Chart & Description Chart Description Bytes Read by Protocol Illustrates the total bytes read from Origin Server(s) by traffic type, for the specified time interval. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 60 Home Download Speed Chart Description Chart Information The information within this chart is shown in a stacked area graph with Date/Time along the X-axis and bytes read in GB along the Y-axis. The legends representing the graph are protocols. Formula The formula used to derive the graph is: Total bytes read from Origin Server(s) split by traffic type. Chart Filters This chart uses Time Range, Origin Server, and Content Acquirer as filters. Download Speed The following table describes the information in the tabular column: Table 32: Download Speed Table & Description Table Description Download Speed Illustrates the number of data ingests based on the download speed, for the specified time interval. Table Information The information within this table are Download Speed (MB/s) and Count. Formula The formula used is: Number of ingests based on the download speed. Filters This table uses Time Range, Origin Server, and Content Acquirer as filters. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 61 Home Ingest Response Codes Ingest Response Codes The following table describes the chart within this dashlet: Table 33: Ingest Response Codes Chart & Description Chart Description Ingest Response Codes Illustrates the ingest response by status codes, for the specified time interval. Chart Information The information within this chart is shown in a bar graph with response Count along the X-axis and Protocol type along the Y-axis. The legends representing the graph are status codes. Formula The formula used to derive the graph is: Count of ingest requests by status codes. Chart Filters This chart uses Time Range, Origin Server, and Content Acquirer as filters. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 62 Home Origin Server Failures Origin Server Failures The following table describes the chart within this dashlet: Table 34: Origin Server Failures Chart & Description Chart Description Origin Server Failures Illustrates the count of ingest requests that failed due to single server and all server, for the specified time interval. Chart Information The information within this chart is shown in a stacked area graph with Data/Time along the X-axis and Count of all server and single server failures along the Y-axis. The legends representing the graph are All Server Failures and Single Server Failures. Formula The formulae used to derive the graph are: Single Server Failures—Count of Server Failures encountered while processing ingest requests. All Server Failures—Origin Server(s) with backup server(s) - All Origin Servers(s) failed. Chart Filters This chart uses Time Range, and Content Acquirer as filters. Note This chart is unaffected by Origin Server filter. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 63 Home Origin Server Failures Note FailoverAction field is not applicable to WMT ingest logs. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 64 CHAPTER 4 Analytics • Analytics Overview, page 65 Analytics Overview This section provides an overview of the VDS-SM Analytics, which provides the ability to view and analyze data that are collected about trends, reports, content, and sessions in textual and graphical form. Data is pushed from various streaming devices to the Splunk Universal Forwarder, and then to the VDS-SM. The data available is used to provide a multitude of historical search capabilities. Data is gathered using predefined indexing metrics, designed to provide data that is monitored by service provider operators. The data output is viewed in the form of a dashlet. Analyze Metrics with Pivoting This feature allows the CDN Operators to analyze the data at a granular level. The difference between the Analyze data option on individual charts and generic pivoting is that, in pivoting, you need to select an option to start the analysis. You can analyze the data for the following: • Bandwidth Delivered • Cache Efficiency • Concurrent Active Sessions • GigaBytes Delivered • Requests • Response Codes • Storage Usage • Viewers You can view the data in the following ways: • On clicking the Both tab, the data will be displayed, in a tabular column and chart. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 65 Analytics Analyze Metrics with Pivoting • On clicking the Table tab, the data will be displayed in a tabular column. • On clicking the Chart tab, the data will be displayed in a chart/graph. You can view the same data in different charts and stack modes. For this, click the Chart type and Stack mode drop-down lists respectively, and choose the required chart and stack mode. The different chart types are column, bar, line, area, and pie. The different types of stack modes are stacked, none, and 100% stacked. Note When you choose an option other than Time in the over drop-down list and choose none in the split by drop-down list, additional drop-down lists such as top/bottom and the number of results to be plotted are displayed. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 66 Analytics Trends To further enhance the analysis, three more dimensions namely Session Duration,Bytes Delivered, and City are added to the Viewers Category under the over and split by drop-down lists in Cisco VDS-SM Release 3.3. Note We have assumed that the users are aware of selecting the relevant dimensions in both the drop-down lists to view the desired result. To access this feature, perform the following steps: Step 1 Choose Analytics > Analyze Metrics with Pivoting. Step 2 From the Pivot on: drop-down list, choose the category for which you need to analyze the data. Step 3 From the Analyze, of, over, and split by drop-down lists, choose the required options. Note Make sure that you choose different options from over and split by drop-down lists. Trends This feature allows you to view the historical data (more than 7 days), in a graph and tabular column. VDS-SM Analytics gather historical data from different perspectives, such as the following: • Network • Streaming • Viewers • Content • Content Origin • Billing When you click each of these categories, the respective subcategories are expanded. On further expanding the subcategories, the respective dashlets are listed. When each of these dashlets are selected, the corresponding charts and data (in a tabular column) are displayed on the right pane. When you click View results option below the charts, the log information corresponding to the dashlet is displayed. Note In the search field, which is located in the left pane, enter the dashlet name or part of the dashlet name as a search string. This will display the receptive dashlet names. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 67 Analytics Trends Network Network trends dashboard provides an historical information on volume, caching, request, and response of the managed CDN network. To access this feature, perform the following: 1. From the main page, choose Analytics > Trends. 2. From the tree view, which appears in the left pane, select Network. The following subcategories are displayed in Network: • Volume • Caching • Request • Response Volume This category includes data and charts for Throughput, Volume of Data Delivered, Delivery Services by Bytes Delivered, Origin/Ingest Volume, Average Download Speed, and Predict Throughput. Throughput For details, see Throughput , on page 33 Note This chart is available to the Wholesale users and CDN Operators. Volume of Data Delivered For details, see Volume Delivered by Protocol , on page 39 Note This chart is available to the Wholesale users and CDN Operators. Delivery Services by Bytes Delivered The following table describes the chart within this dashlet: Videoscape Distribution Suite Service Manager User Guide, Release 3.3 68 Analytics Trends Table 35: Delivery Services by Bytes Delivered Chart & Description Chart Description Delivery Services by Bytes Delivered Illustrates the top delivery services, based on the content delivered, for the specified time interval. Chart Information The information within this chart is a bar graph with the bytes delivered in GB along the X-axis and Delivery Service along the Y-axis. Formula The formula used to derive the graph is: Top 'n' delivery services by total bytes delivered. Chart Filters This chart uses Delivery Server Group, Delivery Server, Provider, Delivery Service, and the Time Range Picker as filters. Availability This chart is available only to the CDN Operators. You can also view the top delivery services, such as top 10 and top 20, by clicking the Sorting Criteria drop-down list. Origin/Ingest Volume For details, see Origin/Ingest Volume, on page 59 Note This chart is available only to the CDN Operators. Average Download Speed The following table describes the chart within this dashlet: Videoscape Distribution Suite Service Manager User Guide, Release 3.3 69 Analytics Trends Table 36: Average Download Speed Chart & Description Chart Description Average Download Speed Illustrates the average download speed of the content providers, for the specified time interval. Chart Information The information within this chart is a line graph with Date/Time along the X-axis and average download speed in KB\s along the Y-axis. The legends representing the graph are Content Providers. Formula The formula used to calculate average download speed is: 1 Dividing total bytes delivered by total time to serve. 2 Drop the lowest 15% of the download speeds and then calculate the average per Content Provider. Chart Filters This chart uses Content Provider, and Time Range Picker as filters. Availability This chart is available only to the CDN Operators. Predict Throughput The following table describes Predict Throughput - Seasonal chart within this dashlet: Table 37: Predict Throughput - Seasonal Chart & Description Chart Description Predict Throughput - Seasonal ` Illustrates the predicted bandwidth of the network using the seasonal approach, for the specified time interval. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 70 Analytics Trends Chart Description Chart Information The information within this chart is a line graph with Date/Time along the X-axis and bandwidth in Gbps along the Y-axis. The legends representing the graph are Average Bandwidth, Ceiling, Floor, and Predicted Bandwidth. Formula The formula used to derive the graph is: Take a series of throughput numbers observed over time and then apply Seasonal Local Level forecasting algorithm on these previous throughput numbers. Chart Filter This chart uses Time Range Picker as filter. Availability This chart is available only to the CDN Operators. The following table describes Predict Throughput - Trend chart within this dashlet: Table 38: Predict Throughput - Trend Chart & Description Chart Description Predict Throughput - Trend Illustrates the predicted bandwidth of the network by trend approach, for the specified time interval. Chart Information The information within this chart is a line graph with Date/Time along the X-axis and bandwidth in Gbps along the Y-axis. The legends representing the graph are Average Bandwidth, Ceiling, Floor, and Predicted Bandwidth. Formula The formula used to derive the graph is: Take a series of throughput numbers observed over time and then apply Local Level Trend forecasting algorithm on these previous throughput numbers. Chart Filter This chart uses Time Range Picker as filter. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 71 Analytics Trends Chart Description Availability This chart is available only to the CDN Operators. Caching This category includes the data and charts for Cache Hit and Miss Rate by Request Count, % Cache Hit and Miss, Storage Usage, and Cache Hit Ratio by Protocol. Cache Hit and Miss Rate by Request Count The following table describes the chart within this dashlet: Table 39: Cache Hit and Miss Rate by Request Count Chart & Description Chart Description Cache Hit and Miss Rate by Request Count Illustrates the rate of cache hit and miss, for the specified time interval. Chart Information The information within this chart is a line graph with Date/Time along the X-axis and Requests per Second along the Y-axis. The legends are Cache Hit and Cache Miss. Formula The formula used to derive the graph is: the rate of cache hit and cache miss requests per second. Chart Filters This chart uses Delivery Server Group, Delivery Server, Provider, Delivery Service, and the Time Range Picker as filters. Availability This chart is available to the Wholesale users and CDN Operators. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 72 Analytics Trends % Cache Hit and Miss The following table describes the chart within this dashlet: Table 40: % Cache Hit and Miss Chart & Description Chart Description % Cache Hit and Miss Illustrates the percentage of cache hits and cache miss, based on the number of requests served and total bytes delivered, for the specified time interval. Chart Information The information within this chart is a stacked area graph with Date/Time along the X-axis and Cache Hit and Cache Miss percentage along the Y-axis. The legends are Cache Hit and Cache Miss. Formula The formula used to derive the requests served graph is: percentage of cache hit and cache miss over total requests. The formula used to derive the bytes delivered graph is: percentage of cache hit bytes and cache miss bytes over total bytes delivered. Chart Filters This chart uses Delivery Server Group, Delivery Server, Provider, Delivery Service, and the Time Range Picker as filters. Availability This chart is available to the Wholesale users and CDN Operators. You can view the request served and bytes delivered by clicking the respective radio buttons. Storage Usage For details, see Storage Usage, on page 37 Note This chart is available only to the CDN Operators. Cache Hit Ratio by Protocol For details, see Cache Hit Ratio by Protocol, on page 42 Videoscape Distribution Suite Service Manager User Guide, Release 3.3 73 Analytics Trends Note This chart is available only to the CDN Operators. Request This category includes data and charts for Request Rate, Total Requests and Errors, and Top Delivery Services by Request Count. Request Rate The following table describes the chart within this dashlet: Table 41: Request Rate Chart & Description Chart Description Request Rate Illustrates the number of requests per second, for the specified time interval. Chart Information The information within this chart is a column graph with Date/Time along the X-axis and Requests per Second along the Y-axis. Formula The formula used to derive the graph is: the number of requests per second. Chart Filters This chart uses Delivery Server Group, Delivery Server, Provider, Delivery Service, and the Time Range Picker as filters. Availability This chart is available to the Wholesale users and CDN Operators. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 74 Analytics Trends Total Requests and Errors The following table describes the chart within this dashlet: Table 42: Total Requests and Errors Chart & Description Chart Description Total Requests and Errors Illustrates the total requests and the number of errors from the total requests, for the specified time interval. Chart Information The information within this chart is an area graph with Date/Time along the X-axis and the requests/error Count along the Y-axis. The legends are Total Requests and Error Count. Formula The formula used to derive the graph is: the total number of requests and errors (requests with status codes 4xx or 5xx). Chart Filters This chart uses Delivery Server Group, Delivery Server, Provider, Delivery Service, and the Time Range Picker as filters. Availability This chart is available to the Wholesale users and CDN Operators. Top Delivery Services by Request Count The following table describes the chart within this dashlet: Videoscape Distribution Suite Service Manager User Guide, Release 3.3 75 Analytics Trends Table 43: Top Delivery Services by Request Count Chart & Description Chart Description Top Delivery Services by Request Count Illustrates the top delivery services by request count, for the specified time interval. Chart Information The information within this chart is a bar graph with request count along the X-axis and the top Delivery Services along the Y-axis. Formula The formula used to derive the graph is: the top 10 delivery services by the number of requests received by them. Chart Filters This chart uses Delivery Server Group, Delivery Server, Provider, Delivery Service, and the Time Range Picker as filters. Availability This chart is available only to the CDN Operators. Response This category includes data and charts for Response Count by Status Codes, Response Codes by Delivery Servers, Response Codes by Service Routers, Sorted Delivery Services by Client Errors on Delivery Servers, 4xx Error Rate on Delivery Servers, 4xx Error Rate on Service Routers, Total Rejections due to Quota Limits, 4xx Errors, Sorted Delivery Services by Client Errors on Service Routers, Response Codes by Protocol, and 4xx Errors by Protocol. Response Count by Status Codes For details, see Response Status Codes, on page 36 Note This chart is available only to the CDN Operators. Response Codes by Delivery Servers The following table describes the chart within this dashlet: Videoscape Distribution Suite Service Manager User Guide, Release 3.3 76 Analytics Trends Table 44: Response Codes by Delivery Servers Chart & Description Chart Description Response Codes by Delivery Servers Illustrates the responses that are grouped by status codes (such as success, client error, and server error: status of a request), for a given delivery server. Chart Information The information within this chart is a stacked bar graph with response Count along the X-axis and the Delivery Server along the Y-axis. The legends are the status codes. Formula The formula used to derive the graph is: the number of responses grouped by the response codes for each delivery server. Chart Filters This chart uses Delivery Server Group, Delivery Server, Provider, Delivery Service, and the Time Range Picker as filters. Availability This chart is available only to the CDN Operators. Response Codes by Service Routers The following table describes the chart within this dashlet: Table 45: Response Codes by Service Routers Chart & Description Chart Description Response Codes by Service Routers Illustrates the responses that are grouped by status codes (client and server errors), for a given service router, for the specified time interval. Chart Information The information within this chart is a stacked area graph with response code Count along the X-axis and Service Router along the Y-axis. Formula The formula used to derive the graph is: the number of responses grouped by the response codes for each service router. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 77 Analytics Trends Chart Description Chart Filters This chart uses Service Router, Provider, Delivery Service, and the Time Range Picker as filters. Availability This chart is available only to the CDN Operators. Sorted Delivery Services by Client Errors on Delivery Servers The following table describes the chart within this dashlet: Table 46: Sorted Delivery Services by Client Errors on Delivery Servers Chart & Description Chart Description Sorted Delivery Services by Client Errors on Delivery Illustrates the top 10 delivery services by client errors. Servers Chart Information The information within this chart is a bar graph with error Count along the X-axis and Delivery Service along the Y-axis. Formula The formula used to derive the graph is: the top 10 delivery services by the number of 4xx errors. Chart Filters This chart uses Delivery Server Group, Delivery Server, Provider, Delivery Service, and the Time Range Picker as filters. Availability This chart is available only to the CDN Operators. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 78 Analytics Trends 4xx Error Rate on Delivery Servers The following table describes the chart within this dashlet: Table 47: 4xx Error Rate on Delivery Servers Chart & Description Chart Description 4xx Error Rate on Delivery Servers Illustrates the number of 4xx errors per second for each delivery server, for the specified time interval. Chart Information The information within this chart is a line graph with Date/Time along the X-axis and 4xx Errors/Second along the Y-axis. The legends are Delivery Servers. Formula The formula used to derive the graph is: the number of errors per day for each delivery server. Chart Filters This chart uses Delivery Server Group, Delivery Server, Provider, Delivery Service, and the Time Range Picker as filters. Availability This chart is available only to the CDN Operators. 4xx Error Rate on Service Routers The following table describes the chart within this dashlet: Videoscape Distribution Suite Service Manager User Guide, Release 3.3 79 Analytics Trends Table 48: 4xx Error Rate on Service Routers Chart & Description Chart Description 4xx Error Rate on Service Routers Illustrates the number of 4xx errors per second for each service router, for the specified time interval. Chart Information The information within this chart is a line graph with Date/Time along the X-axis and Errors/Second along the Y-axis. The legends are Service Routers. Formula The formula used to derive the graph is: the number of errors per second for each service router. Chart Filters This chart uses Service Router, Provider, Delivery Service, and the Time Range Picker as filters. Availability This chart is available only to the CDN Operators. Total Rejections due to Quota Limits The following table describes the chart within this dashlet: Table 49: Total Rejections due to Quota Limits Chart & Description Chart Description Total Rejections due to Quota Limits Illustrates the number of sessions rejected due to quota limits, for the specified time interval. Chart Information The information within this chart is a line graph with Date/Time along the X-axis and Total Sessions and Sessions Rejected along the Y-axis. The legends are Total Sessions and Sessions Declined. Formula The formula used to derive the graph is: total requests and requests with response code 453 or 499 plotted over time. Chart Filters This chart uses Delivery Server Group, Delivery Server, Provider, Delivery Service, and the Time Range Picker as filters. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 80 Analytics Trends Chart Description Availability This chart is available to the Wholesale users and CDN Operators. 4xx Errors The following table describes the chart within this dashlet: Table 50: 4xx Errors Chart & Description Chart Description 4xx Errors Illustrates the number of 4xx errors for each delivery service over a selected period of time. Chart Information The information within this chart is a line graph with Date/Time along the X-axis and Count along the Y-axis. Formula The formula used to derive the graph is: the number of errors per day for each delivery service. Chart Filters This chart uses Provider, Delivery Service, and the Time Range Picker as filters. Availability This chart is available only to the wholesale users. Sorted Delivery Services by Client Errors on Service Routers Videoscape Distribution Suite Service Manager User Guide, Release 3.3 81 Analytics Trends The following table describes the chart within this dashlet: Table 51: Sorted Delivery Services by Client Errors on Service Routers Chart & Description Chart Description Sorted Delivery Services by Client Errors on Service Illustrates the top 10 delivery services by client errors Routers on service routers. Chart Information The information within this chart is a bar graph with error Count along the X-axis and Delivery Services along the Y-axis. Formula The formula used to derive the graph is: top 10 delivery services by the number of 4xx errors occurring at the service router. Chart Filters This chart uses Service Router, Provider, Delivery Service, and the Time Range Picker as filters. Availability This chart is available only to the CDN Operators. Response Codes by Protocol For details, see Response Codes by Protocol, on page 41 Note This chart is available only to the CDN Operators. 4xx Errors by Protocol For details, see 4xx Errors by Protocol, on page 44 Note This chart is available only to the CDN Operators. Streaming Streaming trends dashboard provides an historical information on sessions and ABR of the managed CDN network. To access this feature, perform the following steps: 1 From the main page, choose Analytics > Trends. 2 From the tree view, which appears in the left pane, select Streaming. The following subcategories are displayed in Streaming: • Sessions • ABR Videoscape Distribution Suite Service Manager User Guide, Release 3.3 82 Analytics Trends Sessions This category includes data and charts for Concurrent Active Sessions, Total Sessions by Protocol, and Session Download Size. Concurrent Active Sessions For details, see Concurrent Active Sessions, on page 34 Note This chart is available only to the CDN Operators. Total Sessions by Protocol The following table describes the chart within this dashlet: Table 52: Total Sessions by Protocol Chart & Description Chart Description Total Sessions by Protocol Illustrates the number of sessions by protocol, for the specified time interval. Chart Information The information within this chart is a stacked area graph with Date/Time along the X-axis and FMS, HLS, HDS, HSS, PDL_WE, and WMS Count along the Y-axis. The legends are FMS, HLS, HDS, HSS, PDL_WE, and WMS. Formula The formula used to derive the graph is: number of sessions grouped by protocol. Chart Filters This chart uses Delivery Server Group, Delivery Server, Provider, Delivery Service, and the Time Range Picker as filters. Availability This chart is available only to the CDN Operators. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 83 Analytics Trends Session Download Size The following table describes the chart within this dashlet: Table 53: Session Download Size Chart & Description Chart Description Session Download Size Illustrates the maximum, minimum, and average bytes delivered per session, for the specified time interval. Chart Information The information within this chart is a line graph with Date/Time along the X-axis and the Maximum, Minimum, and Average download size in MB along the Y-axis. The legends are Maximum, Minimum, and Average. Formula The formula used to derive the graph is: the maximum, minimum, and average bytes delivered in MB plotted over time. Chart Filters This chart uses Delivery Server Group, Delivery Server, Provider, Delivery Service, and the Time Range Picker as filters. Availability This chart is available only to the CDN Operators. ABR Bitrate For details, see ABR Session Bitrate by Protocol, on page 43 Note This chart is available only to the CDN Operators. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 84 Analytics Trends Bitrate Oscillations The following table describes the chart within this dashlet: Table 54: Bitrate Oscillations Chart & Description Chart Description Bitrate Oscillations Illustrates the number of bitrate shifts for the specified time interval. Chart Information The information within this chart is a line graph with Date/Time along the X-axis and bitrate oscillation Count along the Y-axis. Formula The formula used to derive the graph is: bitrate shifts over time. Chart Filters This chart uses Delivery Server Group, Delivery Server, Provider, Delivery Service, and the Time Range Picker as filters. Availability This chart is available only to the CDN Operators. Total Requests The following table describes the chart within this dashlet: Videoscape Distribution Suite Service Manager User Guide, Release 3.3 85 Analytics Trends Table 55: Total Requests Chart & Description Chart Description Total Requests Illustrates the number of requests by traffic type (only ABR), for the specified time interval. Chart Information The information within this chart is a stacked area graph with Date/Time along the X-axis and the total request Count along the Y-axis. The legends are HLS, HDS, MobiTV, and HSS. Formula The formula used to derive the graph is: the number of requests per ABR protocol. Chart Filters This chart uses Delivery Server Group, Delivery Server, Provider, Delivery Service, and the Time Range Picker as filters. Availability This chart is available only to the CDN Operators. Request Rate The following table describes the chart within this dashlet: Table 56: Request Rate Chart & Description Chart Description Request Rate Illustrates the number of requests per second for each traffic type (HLS, HDS, HSS and MobiTV), for the specified time interval. Chart Information The information within this chart is a line graph with Date/Time along the X-axis and the Requests per Second along the Y-axis. The legends are HLS, HDS, HSS, and MobiTV. Formula The formula used to derive the graph is: the number of requests per second for each traffic type of ABR protocol. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 86 Analytics Trends Chart Description Chart Filters This chart uses Delivery Server Group, Delivery Server, Provider, Delivery Service, and the Time Range Picker as filters. Availability This chart is available only to the CDN Operators. MobiTV Client Log Analysis The following table describes the chart within this dashlet: Table 57: MobiTV Client Log Analysis Chart & Description Chart Description MobiTV Client Log Analysis Illustrates the number of MobiTV client log events per category, for the specified time interval. Chart Information The information within this chart is a column graph with Date/Time along the X-axis and the MobiTV client event Count along the Y-axis. The legends are MobiTV Client events. Formula The formula used to derive the graph is: the number of events for the specified event category split by events over time. Chart Filters This chart uses Event Type Categories and Time Range Picker as filters. Availability This chart is available only to the CDN Operators. Viewers Viewers trends dashboard provides an historical information on the number of unique viewers, viewers by client type, viewer density by location, top viewers, viewers by session duration, viewers by ISP and Net speed, viewers by protocol, and viewers by download size on the managed CDN network. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 87 Analytics Trends To access this feature, perform the following: 1. From the main page, choose Analytics > Trends. 2. From the tree view, which appears in the left hand pane, select Viewers. Number of Unique Viewers For details, see Unique Viewers, on page 52 Note This chart is available to the Wholesale users and CDN Operators. Viewers by Client Type For details, see Viewers by Client Type, on page 53 Note This chart is available to the Wholesale users and CDN Operators. Viewer Density by Location The following table describes the chart within this dashlet: Table 58: Viewer Density by Location Chart & Description Chart Description Viewer Density by Location Illustrates the viewer density per city, for a specified time interval. Chart Information The information within this table are City and Count. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 88 Analytics Trends Chart Description Formula The formula used to derive the table is: number of viewers in each city. Chart Filters This table uses Delivery Server Group, Delivery Server, Provider, Delivery Service, and the Time Range Picker as filters. Availability This table is available to the Wholesale users and CDN Operators. Top Viewers The following table describes the chart within this dashlet: Table 59: Top Viewers Chart & Description Chart Description Top Viewers Illustrates the top viewers by total bytes delivered and request count, for a specified time interval. Chart Information The information within this chart is a bar graph with the Request Count/Bytes Delivered along the X- axis and Client IP address along the Y-axis. Formula The formula used to derive the graph is: top 'n' viewers of requests and bytes delivered. Chart Filters This chart uses Delivery Server Group, Delivery Server, Provider, Delivery Service, and the Time Range Picker as filters. Availability This chart is available to the Wholesale users and CDN Operators. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 89 Analytics Trends You can view the top viewers, such as top 10 and top 20, by choosing the respective options from the Sorting Criteria drop-down list. You can also view the request count and bytes delivered by clicking the respective radio buttons. Viewers by Session Duration For details, see Viewers by Session Duration, on page 57 Note This chart is available to the Wholesale users and CDN Operators. Viewers by ISP, Net Speed For details, see Viewers by ISP and Net Speed, on page 55 Note This chart is available to the Wholesale users and CDN Operators. Viewers by Protocol The following table describes the chart within this dashlet: Table 60: Viewers by Protocol Chart & Description Chart Description Viewers by Protocol Illustrates the number of viewers per protocol, for the specified time interval. Chart Information The information within this chart is a column graph with Protocol along the X-axis and viewer Count along the Y-axis. Formula The formula used to derive the graph is: number of viewers grouped by protocol. Chart Filters This chart uses Delivery Server Group, Delivery Server, Provider, Delivery Service, and the Time Range Picker as filters. Availability This chart is available to the Wholesale users and CDN Operators. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 90 Analytics Trends Viewers by Download Size For details, see Viewers by Download Size, on page 56 Note This chart is available to the Wholesale users and CDN Operators. Content Content trends dashboard provides an historical information on content by client requests, content by bytes transferred, top content by delivery server, average ABR session bitrate by content, top content by city, and top content by client type on the managed CDN network. To access this feature, perform the following: 1. From the main page, choose Analytics > Trends. 2. From the tree view, which appears in the left pane, select Content. Content by Client Requests For details, see Content by Client Request, on page 45 Note This chart is available to the Wholesale users and CDN Operators. Content by Bytes Transferred For details, see Content by Bytes Transferred, on page 46 Note This chart is available to the Wholesale users and CDN Operators. Top Content by Delivery Server For details, see Top Content by Delivery Server, on page 48 Note This chart is available only to the CDN Operators. Average ABR Session Bitrate by Content For details, see Average ABR Session Bitrate by Content, on page 47 Note This chart is available only to the CDN Operators. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 91 Analytics Trends Top Content by City For details, see Top Content by City, on page 49 Note This chart is available to the Wholesale users and CDN Operators. Top Content by Client Type For details, see Top Content by Client Type, on page 50 Note This chart is available to the Wholesale users and CDN Operators. Content Origin Content Origin trends dashboard provides historical information on ingest requests, bytes read, download speed, ingest response codes, and origin server failures on the managed CDN network. To access this feature, perform the following: 1. From the main page, choose Analytics > Trends. 2. From the tree view, which appears in the left pane, select Content Origin. Note Content Origin charts will be displayed only when the Ingest transaction log is forwarded from VDS-IS to VDS-SM. Ingest Requests For details, see Ingest Requests, on page 58 Note This chart is available only to the CDN Operators. Bytes Read For details, see Bytes Read by Protocol, on page 60 Note This chart is available only to the CDN Operators. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 92 Analytics Trends Download Speed The following table describes the chart within this dashlet: Table 61: Download Speed Chart & Description Chart Description Download Speed Illustrates the download speed of data ingest, for the specified time interval. Chart Information The information within this chart is shown in a line graph with Date/Time along the X-axis and the download speed in MB/s along the Y-axis. Formula The formula used to derive the graph is: Total bytes read by total download duration with respect to time intervals. Chart Filters This chart uses Origin Server, Content Acquirer, and Time Range picker as filters. Availability This chart is available only to the CDN Operators. Ingest Response Codes For details, see Ingest Response Codes, on page 62 Note This chart is available only to the CDN Operators. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 93 Analytics Trends Origin Server Failures For details, see Origin Server Failures, on page 63 Note This chart is available only to the CDN Operators. Billing Billing trends dashboard provides an historical information on 95/5 billing and Pay Go Billing on the managed CDN network. To access this feature, perform the following: 1. From the main page, choose Analytics > Trends. 2. From the tree view, which appears in the left hand pane, select Billing. 95/5 Billing The following table describes the chart within this dashlet: Table 62: 95/5 Billing Chart & Description Chart Description 95/5 Billing Illustrates the billing data of previous months, which uses the 95/5 billing method. Chart Information The information within this chart is an area graph with Date/Time along the X-axis and Bandwidth in Mbps along Y-axis. Formula The formula used to derive this is: The average bandwidth from SR Snapshot log by hour. The red line is the 95/5 high bandwidth within the whole month. Chart Filters This chart uses Month and Delivery Service as filters. Availability This chart is available only to the CDN Operators. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 94 Analytics Trends Billing Functionalities By default, billing will be automatically generated daily at 21:30. It creates the billing csv file (detail, summary) for the delivery services in the delivery_service_topology.csv file, which has the billing item. The path to view the billing.csv is: Go to LWF node and navigate to /home/bnisplunk/data/billing Running billing manually To run the billing manually, perform the following steps: 1 Login to the JS node and navigate to opt/splunk/etc/apps/CDN_JS/bin 2 In the above path, run ./hourlyDataCheck.sh -F YYYYMMDD (replace the date for which hourlyDataCheck needs to be executed). The above mentioned script, marks the status as FIXED for every hour of that date in the "cdn_billing_session" index, which means there are NO missing logs. To verify this, perform the following steps: a) Login to JS node and navigate to /opt/splunk/bin b) Run ./splunk search 'index=cdn_billing_session | table Status,TimeId. c) Enter the username and password; Username: admin and Password: Beaumaris1 d) Check the status by verifying that the record is "FIXED YYYYMMDD". This implies that it is in FIXED status for all 24 hours in date YYYYMMDD. 3 In the path mentioned in step 1, run nohup ./repeatCheck.sh -F YYYYMMDD & (replace the date for which repeatCheck needs to be executed). This will mark the status as FORCED for every hour of that date in the "cdn_billing_session" index. Also, an "INDEXED" record for that day is created. This implies that all the logs of that date are indexed. You can verify this by performing the following steps: a) Login to the JS node and navigate to /opt/splunk/bin b) Run ./splunk search 'index=cdn_billing_session | table Status,TimeId' c) Enter the username and password; Username: admin and Password: Beaumaris1 d) Check the status by verifying that the record is "INDEXED YYYYMMDD. This implies that the date YYYYMMDD is already indexed. 4 Login to the LWF node and navigate to opt/splunkforwarder/etc/apps/Billing/bin and run ./billing.sh. The billing files will be generated under the dir "/home/bnisplunk/data/billing". a) Login to the JS node and navigate to /opt/splunk/bin b) Run ./splunk search 'index=cdn_billing_session | table Status,TimeId. c) Enter the username and password; Username: admin and Password: Beaumaris1 d) Check the status by verifying that the record is "BILLED YYYYMMDD". This implies that billing records have been generated for the date YYYYMMDD. The generated CSV files will have the following fields: Detailed csv Videoscape Distribution Suite Service Manager User Guide, Release 3.3 95 Analytics Reports Delivery_Service:<Delivery Service Name> FQDN:<fqdn> provider:<Provider Name> reseller:<Reseller Name> StartTime,EndTime,ClientIP,ServerIP,URL,MB_Bytes_Delivered,error_code Summary csv Date,Total_GB_Bytes_Delivered,Total_Session_Declined_due_to_quota_limits,Total_Sessions_Delivered Pay Go Billing The following table describes the chart within this dashlet: Table 63: Pay Go Billing Chart & Description Chart Description Pay Go Billing Illustrates the volume delivered, which is calculated based on the pay as you go method of billing. Chart Information The information within this chart is a column graph with Date/Time along the X-axis and volume delivered in GB along the Y-axis. Formula The formula used to derive this chart is: flat traffic volume is computed as trapezoid area over flat throughput in a five minute slot. Chart Filters This chart uses Delivery Service, Time Range Picker, and Span (5 minutes, 1 hour, 1 day) as filters. Availability This chart is available only to the CDN Operators. Reports This feature allows you to view the daily, weekly, and monthly reports for CDN traffic, traffic summary by delivery servers, traffic summary by delivery services, delivery server traffic, delivery service traffic, all assets - video, and all assets - non-video. To access this feature, from the main page, choose Analytics > Reports. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 96 Analytics Reports Daily To view the daily reports, select Daily from the Reports main page. CDN Traffic [5 min Intervals] Table 64: CDN Traffic [5 min Intervals] Table & Description Table Description CDN Traffic [5 min Intervals] Illustrates CDN Traffic for the past day in 5 minute intervals. Table Information The information within this table is: _time, peak bandwidth, mean bandwidth, bandwidth peak mean ratio, 95%ile bandwidth, total GB delivered, total GB ingested, cache hits, cache misses, cache hit ratio, mean sessions, peak sessions, sessions peak mean ratio, 95%ile sessions, total requests, successful requests, unsuccessful requests, 4xx errors, 5xx errors, success %. Traffic Summary by Delivery Servers Videoscape Distribution Suite Service Manager User Guide, Release 3.3 97 Analytics Reports Table 65: Traffic Summary by Delivery Servers Table & Description Table Description Traffic Summary by Delivery Servers Illustrates the traffic summary for the past day for each delivery server. Information The information within this table is: delivery server, peak bandwidth, mean bandwidth, bandwidth peak mean ratio, 95%ile bandwidth, total GB delivered, total GB ingested, cache hits, cache misses, cache hit ratio, mean sessions, peak sessions, sessions peak mean ratio, 95%ile sessions, total requests, successful requests, unsuccessful requests, 4xx errors, 5xx errors, success %. Traffic Summary by Delivery Services Table 66: Traffic Summary by Delivery Services Table & Description Table Description Traffic Summary by Delivery Services Illustrates the traffic summary for the past day for each delivery service. Information The information within this table is: delivery service, peak bandwidth, mean bandwidth, bandwidth peak mean ratio, 95%ile bandwidth, total GB delivered, total GB ingested, cache hits, cache misses, cache hit ratio, mean sessions, peak sessions, sessions peak mean ratio, 95%ile sessions, total requests, successful requests, unsuccessful requests, 4xx errors, 5xx errors, success %. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 98 Analytics Reports Delivery Server Traffic [5 min Intervals] Table 67: Delivery Server Traffic [5 min Intervals] Table & Description Table Description Delivery Server Traffic [5 min Intervals] Illustrates the delivery server traffic details for a selected delivery server in 5 minute intervals Information The information within this table is: _time, peak bandwidth, mean bandwidth, bandwidth peak mean ratio, 95%ile bandwidth, total GB delivered, total GB ingested, cache hits, cache misses, cache hit ratio, mean sessions, peak sessions, sessions peak mean ratio, 95%ile sessions, total requests, successful requests, unsuccessful requests, 4xx errors, 5xx errors, success %. Choose the required delivery server from the Delivery Server drop-down list located above the chart. Delivery Service Traffic [5 min Intervals] Videoscape Distribution Suite Service Manager User Guide, Release 3.3 99 Analytics Reports Table 68: Delivery Service Traffic [5 min Intervals] Table & Description Table Description Delivery Service Traffic [5 min Intervals] Illustrates the delivery service traffic details for a selected delivery service in 5 minute intervals. Information The information within this table is: _time, peak bandwidth, mean bandwidth, bandwidth peak mean ratio, 95%ile bandwidth, total GB delivered, total GB ingested, cache hits, cache misses, cache hit ratio, mean sessions, peak sessions, sessions peak mean ratio, 95%ile sessions, total requests, successful requests, unsuccessful requests, 4xx errors, 5xx errors, success %. Choose the required delivery service from the Delivery Service drop-down list located above the chart. All Assets - Video Table 69: All Assets - Video Table & Description Table Description All Assets - Video Illustrates various metrics for video assets for the past day. Information The information within this table is: URL, Plays, UniqueUsers, Bytes, Minutes, MinutesPerPlay, MinutesPerUser, and PlaysPerUser. Choose the required delivery service from the Delivery Service drop-down list located above the chart. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 100 Analytics Reports All Assets - Non-Video Table 70: All Assets - Non-Video Table & Description Table Description All Assets - Non-Video Illustrates various metrics for non-video assets for the past day. Information The information within this table is: URL, Bytes, Requests, and UniqueUsers. Choose the required delivery service from the Delivery Service drop-down list located above the chart. Weekly To view the daily reports, select Weekly from the Reports main page. CDN Traffic [1 hour Intervals] Table 71: CDN Traffic [1 hour Intervals] Table & Description Table Description CDN Traffic [1 hour Intervals] Illustrates CDN Traffic for the past week in 1 hour intervals. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 101 Analytics Reports Table Description Information The information within this table is: _time, peak bandwidth, mean bandwidth, bandwidth peak mean ratio, 95%ile bandwidth, total GB delivered, total GB ingested, cache hits, cache misses, cache hit ratio, mean sessions, peak sessions, sessions peak mean ratio, 95%ile sessions, total requests, successful requests, unsuccessful requests, 4xx errors, 5xx errors, success %. Traffic Summary by Delivery Servers Table 72: Traffic Summary by Delivery Servers Table & Description Table Description Traffic Summary by Delivery Servers Illustrates the traffic summary for the past week for each delivery server. Information The information within this table is: delivery server, peak bandwidth, mean bandwidth, bandwidth peak mean ratio, 95%ile bandwidth, total GB delivered, total GB ingested, cache hits, cache misses, cache hit ratio, mean sessions, peak sessions, sessions peak mean ratio, 95%ile sessions, total requests, successful requests, unsuccessful requests, 4xx errors, 5xx errors, success %. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 102 Analytics Reports Traffic Summary by Delivery Services Table 73: Traffic Summary by Delivery Services Table & Description Chart Description Traffic Summary by Delivery Services Illustrates the traffic summary for the past week for each delivery service. Information The information within this table is: delivery service, peak bandwidth, mean bandwidth, bandwidth peak mean ratio, 95%ile bandwidth, total GB delivered, total GB ingested, cache hits, cache misses, cache hit ratio, mean sessions, peak sessions, sessions peak mean ratio, 95%ile sessions, total requests, successful requests, unsuccessful requests, 4xx errors, 5xx errors, success %. Delivery Server Traffic [1 hour Intervals] Videoscape Distribution Suite Service Manager User Guide, Release 3.3 103 Analytics Reports Table 74: Delivery Server Traffic [1 hour Intervals] Table & Description Table Description Delivery Server Traffic [1 hour Intervals] Illustrates the delivery server traffic details for a selected delivery server in 1 hour intervals Information The information within this table is: _time, peak bandwidth, mean bandwidth, bandwidth peak mean ratio, 95%ile bandwidth, total GB delivered, total GB ingested, cache hits, cache misses, cache hit ratio, mean sessions, peak sessions, sessions peak mean ratio, 95%ile sessions, total requests, successful requests, unsuccessful requests, 4xx errors, 5xx errors, success %. Choose the required delivery server from the Delivery Server drop-down list located above the chart. Delivery Service Traffic [1 hour Intervals] Table 75: Delivery Service Traffic [1 hour Intervals] Table & Description Table Description Delivery Service Traffic [1 hour Intervals] Illustrates the delivery service traffic details for a selected delivery service in 1 hour intervals. Information The information within this table is: _time, peak bandwidth, mean bandwidth, bandwidth peak mean ratio, 95%ile bandwidth, total GB delivered, total GB ingested, cache hits, cache misses, cache hit ratio, mean sessions, peak sessions, sessions peak mean ratio, 95%ile sessions, total requests, successful requests, unsuccessful requests, 4xx errors, 5xx errors, success %. Choose the required delivery service from the Delivery Service drop-down list located above the chart. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 104 Analytics Reports All Assets - Video Table 76: All Assets - Video Table & Description Table Description All Assets - Video Illustrates various metrics for video assets for the past week. Information The information within this table is: URL, Plays, UniqueUsers, Bytes, Minutes, MinutesPerPlay, MinutesPerUser, and PlaysPerUser. Choose the required delivery service from the Delivery Service drop-down list located above the chart. All Assets - Non-Video Table 77: All Assets - Non-Video Table & Description Table Description All Assets - Non-Video Illustrates various metrics for non-video assets for the past week. Information The information within this table is: URL, Bytes, Requests, and UniqueUsers. Choose the required delivery service from the Delivery Service drop-down list located above the chart. Monthly To view the daily reports, select Monthly from the Reports main page. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 105 Analytics Reports CDN Traffic [1 day Intervals] Table 78: CDN Traffic [1 day Intervals] Table & Description Table Description CDN Traffic [1 hour Intervals] Illustrates CDN Traffic for the past month in 1 day intervals. Information The information within this table is: _time, peak bandwidth, mean bandwidth, bandwidth peak mean ratio, 95%ile bandwidth, total GB delivered, total GB ingested, cache hits, cache misses, cache hit ratio, mean sessions, peak sessions, sessions peak mean ratio, 95%ile sessions, total requests, successful requests, unsuccessful requests, 4xx errors, 5xx errors, success %. Traffic Summary by Delivery Servers Table 79: Traffic Summary by Delivery Servers Table & Description Table Description Traffic Summary by Delivery Servers Illustrates the traffic summary for the past month for each delivery server. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 106 Analytics Reports Table Description Information The information within this table is: delivery server, peak bandwidth, mean bandwidth, bandwidth peak mean ratio, 95%ile bandwidth, total GB delivered, total GB ingested, cache hits, cache misses, cache hit ratio, mean sessions, peak sessions, sessions peak mean ratio, 95%ile sessions, total requests, successful requests, unsuccessful requests, 4xx errors, 5xx errors, success %. Traffic Summary by Delivery Services Table 80: Traffic Summary by Delivery Services Table & Description Table Description Traffic Summary by Delivery Services Illustrates the traffic summary for the past month for each delivery service. Information The information within this table is: delivery service, peak bandwidth, mean bandwidth, bandwidth peak mean ratio, 95%ile bandwidth, total GB delivered, total GB ingested, cache hits, cache misses, cache hit ratio, mean sessions, peak sessions, sessions peak mean ratio, 95%ile sessions, total requests, successful requests, unsuccessful requests, 4xx errors, 5xx errors, success %. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 107 Analytics Reports Delivery Server Traffic [1 day Intervals] Table 81: Delivery Server Traffic [1 day Intervals] Table & Description Table Description Delivery Server Traffic [1 hour Intervals] Illustrates the delivery server traffic details for a selected delivery server in 1 day intervals Information The information within this table is: _time, peak bandwidth, mean bandwidth, bandwidth peak mean ratio, 95%ile bandwidth, total GB delivered, total GB ingested, cache hits, cache misses, cache hit ratio, mean sessions, peak sessions, sessions peak mean ratio, 95%ile sessions, total requests, successful requests, unsuccessful requests, 4xx errors, 5xx errors, success %. Choose the required delivery server from the Delivery Server drop-down located above the chart. Delivery Service Traffic [1 day Intervals] Videoscape Distribution Suite Service Manager User Guide, Release 3.3 108 Analytics Reports Table 82: Delivery Service Traffic [1 day Intervals] Table & Description Table Description Delivery Service Traffic [1 hour Intervals] Illustrates the delivery service traffic details for a selected delivery service in 1 day intervals. Information The information within this table is: _time, peak bandwidth, mean bandwidth, bandwidth peak mean ratio, 95%ile bandwidth, total GB delivered, total GB ingested, cache hits, cache misses, cache hit ratio, mean sessions, peak sessions, sessions peak mean ratio, 95%ile sessions, total requests, successful requests, unsuccessful requests, 4xx errors, 5xx errors, success %. Choose the required delivery service from the Delivery Service drop-down list located above the chart. All Assets - Video Table 83: All Assets - Video Table & Description Table Description All Assets - Video Illustrates various metrics for video assets for the past month. Information The information within this table is: URL, Plays, UniqueUsers, Bytes, Minutes, MinutesPerPlay, MinutesPerUser, and PlaysPerUser. Choose the required delivery service from the Delivery Service drop-down list located above the chart. All Assets - Non-Video Videoscape Distribution Suite Service Manager User Guide, Release 3.3 109 Analytics Custom Searches and Reports Table 84: All Assets - Non-Video Table & Description Table Description All Assets - Non-Video Illustrates various metrics for non-video assets for the past month. Information The information within this table is: URL, Bytes, Requests, and UniqueUsers. Choose the required delivery service from the Delivery Service drop-down list located above the chart. Custom Searches and Reports This feature displays all the saved searches as reports. You can view both, public and private reports. However, you cannot view the private reports saved by another user. In this feature, only the Delete and Refresh options are available. You will not be able to modify any saved reports. To view custom reports, perform the following: From the main page, choose Analytics > Custom Searches and Reports. Note • If you upgrade VDS-SM from version 3.1 to 3.3 or 3.2 to 3.3, then the public custom reports created in earlier version will not be migrated to the upgraded version. • If you have multiple reports, enter the search name in the filter, which is located in the left pane and the particular saved search will be displayed. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 110 Analytics Custom Searches and Reports Creating a Custom Report To create custom reports, perform the following steps: Step 1 Step 2 Step 3 Choose Analytics > Custom Searches and Reports. In the Search field, enter the query for which you want to generate a report and click , in the right pane. Choose Save As > Report. The Save As Report panel appears. Step 4 Step 5 Step 6 Provide the report Title, and Description (optional). Click the preferred Visualization button on how you want the report to appear. Click Yes to add Time Range Picker, and click No to create a report without time range picker. Step 7 Click Save. The Your Report Has Been Created panel appears. Step 8 Click View to see the created report. Click Add to Dashboard to create a custom dashboard for given search query (see Adding a Custom Dashboard topic in Custom Dashboards, on page 112), or click Continue Editing to navigate to the search page. Remember Created custom report will be added to the tree view only after clicking pane. in the left Videoscape Distribution Suite Service Manager User Guide, Release 3.3 111 Analytics Custom Dashboards Deleting a Custom Report To delete a custom report, perform the following steps: Step 1 Choose Analytics > Custom Searches and Reports. Step 2 Step 3 From the left pane, select the custom report, which you want to delete and click . The delete confirmation dialog box appears. Click Yes to permanently delete the custom report, or click No to cancel the deletion. Custom Dashboards This feature allows the CDN operators to create and save custom dashboards using the search application. You can view the list of all custom dashboards created by you and other users. To access this feature, from the main page, choose Analytics > Custom Dashboards. You can view the custom dashboards in the left pane. Click the arrow next to My Dashboards and select the custom dashboard, which you want to view. The details will be displayed in the right pane. This feature allows you to create, delete, and refresh custom dashboards. By default, the custom dashboards are grouped by username. • If you manually modify the savedsearches.conf file in the JS node, the savedsearches.conf file under the SH node will be updated and thereby, all the searches will be deleted. Note • If you upgrade VDS-SM from version 3.1 to 3.3 or 3.2 to 3.3, then the public custom dashboards created in earlier version will not be migrated to the upgraded version. Adding a Custom Dashboard To add a custom dashboard, perform the following steps: Step 1 Step 2 Step 3 Step 4 Choose Analytics > Custom Dashboards. Click . In the right pane, enter the query in the Search field and click Choose Save As > Dashboard Panel. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 112 . Analytics Custom Dashboards The Save As Dashboard Panel appears. Step 5 To create a new custom dashboard, perform the following: a) Click New. b) Dashboard Title (Optional)—Enter the custom dashboard title. Note We recommend that you always start the custom dashboard names with the word Custom (or any word other than dashboard). The usage of Custom helps the users to add panels to existing custom dashboard. c) Dashboard ID—Enter the custom dashboard ID. Note The custom dashboard ID can contain only alpha numeric characters and underscores. d) Dashboard Description (Optional)—Enter the custom dashboard description. e) Dashboard Permissions—Select the custom dashboard permissions as Private or Shared in App. • Private—You can only view and edit the custom dashboard. • Shared in App—All users can view the created custom dashboard. Note You can edit the custom dashboard based on the role. The following table provides the role and permission details: Table 85: Permission Details Role1 Role based Permissions Admin User Power Can_delete Splunk_System_Role Videoscape Distribution Suite Service Manager User Guide, Release 3.3 113 Analytics Custom Dashboards Admin Edit, Delete, Edit Clone Permissions and Clone User Sharing option is not available Power Edit, Delete , Edit Clone Permissions and Clone Can_delete Search is not possible Splunk_System_Role Edit, Delete , Edit Clone Permissions and Clone 1 Edit, Delete and Clone No Edit, Delete , Edit Permissions and Clone Edit, Delete , Edit No Permissions and Clone Edit, Delete , Edit Permissions and Clone Edit, Delete and Clone Edit, Delete , Edit Permissions and Clone No Refers to the role of the user who created the custom dashboard. f) Panel Title (Optional)—Enter the panel title. g) Panel Content—Select the panel content as Statistics or Column. • Statistics—Displays data in table format. • Column—Displays data as column chart. h) Click Save. Step 6 To add a panel in an existing custom dashboard, in the Save As Dashboard Panel dialog box perform the following: a) Click Existing. b) From the drop-down list, choose the required custom dashboard. Note You can only add panels to the custom dashboards that are created using the custom dashboard interface. c) Panel Content—Select the panel content as Statistics or Column. • Statistics—Displays data in table format. • Column—Displays data as column chart. d) Click Save. Your Dashboard Panel Has Been Created dialog box appears. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 114 Analytics Content Step 7 Click View Dashboard. Remember Note Refresh the custom dashboards by clicking in the left pane to view the created custom dashboard name in the tree view. The respective searches will be saved under Custom Searches and Reports. Deleting a Custom Dashboard To delete a custom dashboard, perform the following steps: Step 1 Choose Analytics > Custom Dashboards. Step 2 Step 3 From the left pane, select the custom dashboard, which you want to delete. Choose Delete from the Edit drop-down list. The Delete confirmation dialog box appears. Click Delete. Note If you are deleting one or more searches that is being used by one or more custom dashboards, then those custom dashboards will not work. Also, the search saved as part of custom dashboards will have to be deleted manually. Step 4 Remember Deleted custom dashboard will be removed from the tree view only after clicking pane. in the left Content In this feature, the users will be able to analyze the data, based on the content title. They can also generate viewership report, based on various metrics. Analyze by Content Title This feature provides a platform for the users to analyze individual asset (content title), based on various metrics such as Usage, Audience, QoS, and Errors. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 115 Analytics Content To analyze the content title, perform the following steps: Step 1 From the main page, choose Analytics > Content > Analyze by Content Title. Step 2 Choose the desired delivery service and the time range from the respective drop-down lists, and enter the search asset name in the Search Asset name field. Then, click Search. Note Entering certain search asset name values such as space and individual characters in the Search Asset Name text box will display large results. This may impact the system's performance. Step 3 From the list of unique content titles that are displayed in a tabular format, choose the desired Title. Different tabs such as Usage, Audience, QoS, and Errors for that particular title are displayed. Click the respective tabs to view the corresponding charts. The different charts are explained in detail here. Usage Bytes Delivered The following table describes the information in the chart: Table 86: Bytes Delivered Chart & Description Chart Description Bytes Delivered Illustrates the bytes delivered (MB) over time for the given content title. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 116 Analytics Content Chart Description Chart Information The information within this chart is shown in a column graph with the Date/Time along the X-axis and the bytes delivered in MB along the Y-axis. Formula The formula used to derive this graph is: the total bytes delivered for the given content title plotted over time. Filters This chart uses Delivery Service, and Time Range (Previous day and Last 7 days), as filters. Bytes Delivered by Delivery Server The following table describes the information in the tabular column: Table 87: Bytes Delivered by Delivery Server Table & Description Table Description Bytes Delivered by Delivery Server Illustrates the bytes delivered (MB) per delivery server for the given content title. Information The information within this table are Delivery Server and MB. Formula The formula used is: total bytes delivered for the given content title in each delivery server. Filters This table uses Delivery Service, and Time Range (Previous day and Last 7 days), as filters. Bytes Delivered by City The following table describes the information in the tabular column: Videoscape Distribution Suite Service Manager User Guide, Release 3.3 117 Analytics Content Table 88: Bytes Delivered by City Table & Description Table Description Bytes Delivered by City Illustrates the bytes delivered (MB) per city for the given content title. Information The information within this table are City and MB. Formula The formula used is: total bytes delivered for the given content title in each city. Filters This table uses Delivery Service, and Time Range (Previous day and Last 7 days), as filters. Note The city will be resolved only for public IPs. IPs which cannot be resolved by MaxMind will not be displayed. Bytes Delivered by ISP and Net Speed The following table describes the information in the tabular column: Table 89: Bytes Delivered by ISP and Net Speed Table & Description Table Description Bytes Delivered by ISP and Net Speed Illustrates the bytes delivered (MB), grouped by ISP or Net Speed for the given content title. Table Information The information within this table are ISP or Net Speed and MB. Formula The formula used is: total bytes delivered for the given content title grouped by the client ISP or Net Speed. Filters This table uses Delivery Service, and Time Range (Previous day and Last 7 days), as filters. Note Other than public IPs, "unknown" value will be displayed. Bytes Delivered by Client Type Videoscape Distribution Suite Service Manager User Guide, Release 3.3 118 Analytics Content The following table describes the information in the tabular column: Table 90: Bytes Delivered by Client Type Table & Description Table Description Bytes Delivered by Client Type Illustrates the bytes delivered per client type (MB) for the given content title. Table Information The information within this table are Client Type and MB. Formula The formula used is: total bytes delivered for the given content title grouped by the client type. Filters This table uses Delivery Service, and Time Range (Previous day and Last 7 days), as filters. Audience Total Sessions The following table describes the information in the chart: Table 91: Total Sessions Chart & Description Chart Description Total Sessions Illustrates the number of sessions over time for the given content title. Chart Information The information within this chart is shown in a column graph with the Date/Time along the X-axis and the Total Sessions Count along the Y-axis. Formula The formula used to derive this graph is: the total number of sessions for a given content title plotted over time. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 119 Analytics Content Chart Description Filters This chart uses Delivery Service, and Time Range (Previous day and Last 7 days), as filters. Unique Viewers The following table describes the information in the chart: Table 92: Unique Viewers Chart & Description Chart Description Unique Viewers Illustrates the number of unique viewers over time for the given content title. Chart Information The information within this chart is shown in a column graph with the Date/Time along the X-axis and the Unique Viewers count along the Y-axis. Formula The formula used to derive this graph is: the number of unique viewers for the given content title plotted over time. Filters This chart uses Delivery Service, and Time Range (Previous day and Last 7 days), as filters. Viewers by Download Size and Session Duration The following table describes the information in the tabular column: Videoscape Distribution Suite Service Manager User Guide, Release 3.3 120 Analytics Content Table 93: Viewers by Download Size and Session Duration Table & Description Table Description Viewers by Download Size and Session Duration Illustrates the number of sessions grouped by download size or duration for the given content title. Table Information The information within this table are Download Size, Session Duration, and Count. Formula The formula used is: the number of viewers bucketed by the download size in MB, for the given content title. The formula used for Duration is: the number of viewers bucketed by the average session duration for the given content title. Filters This table uses Delivery Service, and Time Range (Previous day and Last 7 days), as filters. Viewers by ISP and Net Speed The following table describes the information in the tabular column: Table 94: Viewers by ISP and Net Speed Table & Description Table Description Viewers by ISP and Net Speed Illustrates the number of sessions grouped by ISP and Net Speed for the given content title. Table Information The information within this table are ISP, Net Speed and the Viewer count. Formula The formula used is: the number of viewers grouped by client ISP/Net Speed for the given content title. Filters This table uses Delivery Service, and Time Range (Previous day and Last 7 days), as filters. Note Other than public IPs, "unknown" value will be displayed. Viewers by City Videoscape Distribution Suite Service Manager User Guide, Release 3.3 121 Analytics Content The following table describes the information in the tabular column: Table 95: Viewers by City Table & Description Table Description Viewers by City Illustrates the number of viewers per city for the given content title. Table Information The information within this table are City and Count. Formula The formula used is: the number of viewers in each city for the given content title. Filters This table uses Delivery Service, and Time Range (Previous day and Last 7 days), as filters. Note The city will be resolved only for public IPs. IPs which cannot be resolved by MaxMind will not be displayed. QoS Average ABR Session Bitrate The following table describes the information in the chart: Table 96: Average ABR Session Bitrate Chart & Description Chart Description Average ABR Session Bitrate Illustrates the average ABR session bitrate (Kbps) over time for the given content title. Chart Information The information within this chart is shown in a column graph with the Date/Time along the X-axis and the ABR Session Bitrate (Kbps) along the Y-axis. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 122 Analytics Content Chart Description Formula The formula used to derive this graph is: the average bitrate plotted over time for the given content title. Filters This chart uses Delivery Service, and Time Range (Previous day and Last 7 days), as filters. Bitrate Oscillations The following table describes the information in the chart: Table 97: Bitrate Oscillations Chart & Description Chart Description Bitrate Oscillations Illustrates the number of bitrate oscillations for the given content title over time. Chart Information The information within this chart is shown in a column graph with the Date/Time along the X-axis and oscillation Count along the Y-axis. Formula The formula used to derive this graph is: the number of bitrate shift events for a given content title. Filters This chart uses Delivery Service, and Time Range (Previous day and Last 7 days), as filters. Average ABR Session Bitrate by Client Type Videoscape Distribution Suite Service Manager User Guide, Release 3.3 123 Analytics Content The following table describes the information in the tabular column: Table 98: Average ABR Session Bitrate by Client Type Table & Description Table Description Average ABR Session Bitrate by Client Type Illustrates the average ABR session bitrate (Kbps) per client type for the given content title. Table Information The information within this table are Client Type and Bitrate. Formula The formula used is: average ABR session bitrate (Kbps) for the given content title, grouped by the client type. Filters This table uses Delivery Service, and Time Range (Previous day and Last 7 days), as filters. Average ABR Session Bitrate by City The following table describes the information in the tabular column: Table 99: Average ABR Session Bitrate by City Table & Description Table Description Average ABR Session Bitrate by City Illustrates the average ABR session bitrate (Kbps) per city for the given content title. Table Information The information within this table are City and Bitrate. Formula The formula used is: average ABR session bitrate (Kbps) for the given content title in each city. Filters This table uses Delivery Service, and Time Range (Previous day and Last 7 days), as filters. Note The city will be resolved only for public IPs. IPs which cannot be resolved by MaxMind will not be displayed. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 124 Analytics Content Average ABR Session Bitrate by ISP and Net Speed The following table describes the information in the tabular column: Table 100: Average ABR Session Bitrate by ISP and Net Speed Table & Description Table Description Average ABR Session Bitrate by ISP and Net Speed Illustrates the average ABR session bitrate (Kbps) grouped by ISP and Net Speed for the given content title. Table Information The information within this table are Client ISP/Net Speed and Bitrate. Formula The formula used is: average ABR session bitrate (Kbps) for the given content title grouped by the client ISP and Net Speed. Filters This table uses Delivery Service, and Time Range (Previous day and Last 7 days), as filters. Note Other than public IPs, "unknown" value will be displayed. Errors 4xx and 5xx Errors The following table describes the information in the chart: Table 101: 4xx and 5xx Errors Chart & Description Chart Description 4xx and 5xx Errors Illustrates the number of 4xx and 5xx (client and server) errors over time for the given content title. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 125 Analytics Content Chart Description Chart Information The information within this chart is shown in a column graph with the Date/Time along the X-axis and the Error count along the Y-axis. Formula The formula used to derive this graph is: the number of 4xx and 5xx errors plotted over time for the given content title. Filters This chart uses Delivery Service, and Time Range (Previous day and Last 7 days), as filters. 4xx and 5xx Errors The following table describes the information in the tabular column: Table 102: 4xx and 5xx Errors Table & Description Table Description 4xx and 5xx Errors Illustrates the number of 4xx and 5xx (client and server) errors for the given content title. Table Information The information within this table are 4xx Errors, and 5xx Errors. Formula The formula used is: the number of 4xx and 5xx errors occurred for the given content title. Filters This chart uses Delivery Service, and Time Range (Previous day and Last 7 days), as filters. 4xx and 5xx Errors by Device The following table describes the information in the tabular column: Videoscape Distribution Suite Service Manager User Guide, Release 3.3 126 Analytics Content Table 103: 4xx and 5xx Errors by Device Table & Description Table Description 4xx and 5xx Errors by Device Illustrates the number of 4xx and 5xx (client and server) errors per device (delivery servers and service routers) for the given content title. Table Information The information within this table are Device Name, 4xx, and 5xx Errors. Formula The formula used is: the number of 4xx and 5xx errors occurring in each device (delivery servers and service routers) for the given content title. Filters This table uses Delivery Service, and Time Range (Previous day and Last 7 days), as filters. 4xx and 5xx Errors by City The following table describes the information in the tabular column: Table 104: 4xx and 5xx Errors by City Table & Description Table Description 4xx and 5xx Errors by City Illustrates the number of 4xx and 5xx (client and server) errors per city for the given content title. Table Information The information within this table are City, 4xx, and 5xx errors. Formula The formula used is: the number of 4xx and 5xx errors occurring in each city for the given content title. Filters This table uses Delivery Service, and Time Range (Previous day and Last 7 days), as filters. 4xx and 5xx Errors by Client Type Videoscape Distribution Suite Service Manager User Guide, Release 3.3 127 Analytics Content The following table describes the information in the tabular column: Table 105: 4xx and 5xx Errors by Client Type Table & Description Table Description 4xx and 5xx Errors by Client Type Illustrates the number of 4xx and 5xx (client and server) errors grouped by client type for the given content title. Table Information The information within this table are Client Type, 4xx, and 5xx errors. Formula The formula used is: the number of 4xx and 5xx errors occurring in each client type for the given content title. Filters This table uses Delivery Service, and Time Range (Previous day and Last 7 days), as filters. Viewership Report This feature provides a platform for the users to generate viewership reports, based on various metrics such as Delivery Server Group, Delivery Server, Provider, Service Type, Delivery Service, Resolution, and Genre. To generate viewership report, perform the following steps: Step 1 From the main page, choose Analytics > Content > Viewership Report. Step 2 Choose the Delivery Server Group, Delivery Server, Provider, Service Type, Delivery Service, Resolution, Genre, and Time Range Picker from the respective drop-down lists and click Filter. The viewership report is displayed. By clicking an asset name in the Viewership report, you will be navigated to the Analyze by Content Title page with the selected asset name pre-populated in the search Asset Name field. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 128 Analytics Sessions Sessions In this feature, the users will be able to analyze the data, based on the session title. They can also generate session report, based on various parameters. Analyze by Client IP This feature provides a platform for users to analyze the individual client IP, based on various parameters such as sessions created for the IP, session duration, protocol used to serve the content, and title viewed during the session. To access this feature, perform the following steps: Step 1 From the main page, choose Analytics > Sessions > Analyze by Client IP. Step 2 Choose the desired delivery service, select the time range from the respective drop-down lists, and enter the client IP in the search Client IP field. Click Search. Note In the search Client IP field, enter the exact client IP. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 129 Analytics Sessions Step 3 From the sessions counts chart that is displayed, click the desired column. The session details will be displayed below the session count chart. Session Report This feature provides a platform for the users to generate session reports, based on various parameters such as Delivery Server Group, Delivery Server, Provider, and Delivery Service. To access this feature, perform the following steps: Step 1 From the main page, choose Analytics > Sessions > Session Report. Step 2 Choose the Delivery Server Group, Delivery Server, Provider, Delivery Service, and Time Range Picker from the respective drop-down lists and click Filter. The session report is displayed. By clicking the client IP in the session report, you will be navigated to the Analyze by Client IP page with the selected client IP pre-populated in the search Client IP field. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 130 Analytics Geo Analysis Geo Analysis This feature allows to analyze some core CDN metrics over geographic dimension. To access this feature, from the main page, choose Analytics > Geo Analysis. You can view Geo Analysis in the left pane. Click the arrow next to Geo Analysis and select the required map you want to view. The details will be displayed in the right pane. By default, the Cache Hit Ratio by Location map is displayed. Cache Hit Ratio by Location The Cache Hit Ratio by Location map displays the delivery server location as points. When you mouse over a point (server location), the server name and its cache hit ratio will be displayed. The Cache Hit Ratio by Location map uses Time Range, Delivery Server Group, Delivery Server, Provider, and Delivery Service as filters. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 131 Analytics Geo Analysis Viewers Density by Location The Viewers Density by Location map displays the client locations as points. When you mouse over a point (client location), the city name and the number of viewers from that particular city will be displayed. The Viewers Density by Location map uses Time Range, Delivery Server Group, Delivery Server, Provider, Delivery Service, and Media Format as filters. Bytes Delivered by City The Bytes Delivered by City map displays the client locations as points. When you mouse over a point (client location), the city name and the number of bytes delivered (GB) to that particular city will be displayed. The Bytes Delivered by City map uses Time Range, Delivery Server Group, Delivery Server, Provider, Delivery Service, Resolution, and Genre as filters. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 132 Analytics Geo Analysis Average ABR Bitrate by City The Average ABR Bitrate by City map displays the client locations as points. When you mouse over a point (client location), the city name and the average ABR bitrate (Kbps) in that particular city will be displayed. The Average ABR Bitrate by City map uses Time Range, and Delivery Service as filters. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 133 Analytics North Bound Application Programming Interface 4xx and 5xx Errors by City The 4xx and 5xx Errors by City map displays locations of the viewers who are receiving 4xx and 5xx errors. When you mouse over a point (client location), the city name, count of 4xx (client) errors, and count of 5xx (server) errors in that particular city will be displayed. The 4xx and 5xx Errors by City map uses Time Range, and Delivery Service as filters. North Bound Application Programming Interface North Bound Application Programming Interface (NB API) is a programming interface for north bound analytics systems to integrate with VDS-SM and leverage the data maintained in VDS-SM for higher level aggregation and analysis. VDS-SM provides a RESTful Web Services API to query data from VDS-SM for analytics. VDS-SM supports predefined queries/searches to query data corresponding to reports. Each predefined query/search is identified by a name, which corresponds to a particular dashboard. You can query the data by specifying the search name alone. For example, in the CDN Traffic report, the search name is cdntraffic_daily. To obtain the result for a query, you need to perform the HTTPS GET request using the following URL: With Delivery Service Name https://< UI Node IP >:8443/bnimgmt/api/analytics/search/systemdefined/< searchname >?delsvc=<delivery service name> With Delivery Server Name https://< UI Node IP >:8443/bnimgmt/api/analytics/search/systemdefined/< searchname >?host=<delivery server name> Without Delivery Service or Delivery Server Name https://< UI Node IP >:8443/bnimgmt/api/analytics/search/systemdefined/<searchName> Videoscape Distribution Suite Service Manager User Guide, Release 3.3 134 Analytics North Bound Application Programming Interface For example, to execute the search “cdntraffic_daily”, you need to perform GET request using the following URL: https://<UI Node IP>:8443/bnimgmt/api/analytics/search/systemdefined/ cdntraffic_daily You need to specify the Username and Password (CDN Operator Admin and CDN Viewer) for authentication in the “Authorization” header fields of the HTTPS GET request. For example, in command line tools such as curl, provide the following command with credentials: curl -k -u bniadmin:admin --request GET 'https:// <UI Node IP >:8443/bnimgmt/api/analytics/search/ systemdefined/cdntraffic_daily In the URL, you need to pass the delivery service name or delivery server name for a search and not any special characters or space. Note The URL should be exactly the same as mentioned here and they should be entered in a single line. Also, HTTPS is authenticated through self-signed OpenSSL certificate for NB API and NB API does not support HTTP. Result Format Analytics API provides the results in CSV format. The first line is the header line with fields, followed by the data. Following is an example of Console Output. curl -k -u bniadmin:admin --request GET 'https://10.77.246.184:8443/bnimgmt/api/analytics/search/systemdefined/cdntraffic_weekly' Supported Predefined Searches Table 106: Search Name & Optional Parameters Sl. No. Search Name 1 cdntraffic_daily 2 cdntraffic_weekly Optional Parameters Videoscape Distribution Suite Service Manager User Guide, Release 3.3 135 Analytics Generating CSV Files from Search Results (Gencsvfromsearch) Sl. No. Search Name Optional Parameters 3 cdntraffic_monthly 4 trafficsummary_by_deliveryservers_daily 5 trafficsummary_by_deliveryservers_weekly 6 trafficsummary_by_deliveryservers_monthly 7 trafficsummary_by_deliveryservices_daily 8 trafficsummary_by_deliveryservices_weekly 9 trafficsummary_by_deliveryservices_monthly 10 deliveryserver_traffic_daily delivery_server_name 11 deliveryserver_traffic_weekly delivery_server_name 12 deliveryserver_traffic_monthly delivery_server_name 13 deliveryservice_traffic_daily delivery_service_name 14 deliveryservice_traffic_weekly delivery_service_name 15 deliveryservice_traffic_monthly delivery_service_name Generating CSV Files from Search Results (Gencsvfromsearch) VDS-SM provides the capability to generate CSV files from search results. Specific dashboard searches with default configurations and the search results are exported securely in CSV format through FTP, SFTP password-based authentication, and SFTP key-based authentication. Users can define multiple FTP/SFTP destination servers. If the server is the same, but has different destination directories, then the user needs to define separate SFTP server configuration blocks in the configuration files. To generate CSV files from search results, perform the following steps: Step 1 Step 2 Configure the search file (search_spec.conf) based on the respective protocol (FTP/SFTP) parameters. Run either the shell script (gencsvfromsearch.sh) or python script (gencsvfromsearch.py). Configuring Search File The search_spec.conf file specifies the searches for which the results will be exported to the server. The search_spec.conf file must be updated for the respective protocol (FTP\SFTP) parameters. The following table lists the parameters that need to be configured in search_spec.conf for FTP or SFTP export: Videoscape Distribution Suite Service Manager User Guide, Release 3.3 136 Analytics Generating CSV Files from Search Results (Gencsvfromsearch) Table 107: Protocol Parameters Parameter Description SFTPServer.SFTP.ip = Defines the SFTP export server IP address. SFTPServer.SFTP.port = Defines the SFTP port number for exports. SFTP=22 (default port usage). SFTPServer.SFTP.username = Defines the SFTP export server username. SFTPServer.SFTP.password = Defines the SFTP export server password. SFTPServer.SFTP.directory = Defines the SFTP export location of the CSV files. SFTPServer.SFTP.keyfile.location = Defines the path to the private key file of the server. SFTPServer.SFTP.keyfile. passcode = Defines the password of the public key file (if required). SFTPServer.SFTP.keyfile.type = Defines the type of the public key file, that is, RSA or DSS. FTPServer.FTP.ip = Defines the FTP export server IP address. FTPServer.FTP.port = Defines the FTP port number for exports. FTP=21 (default port usage). FTPServer.FTP.username = Defines the FTP export server username. FTPServer.FTP.password = Defines the FTP export server password. FTPServer.FTP.directory = Defines the FTP export location of the CSV files. To configure the search file, perform the following steps: Step 1 Log in to Job scheduler node using the following credentials: Username: bnisplunk Password: <password> Step 2 Navigate to the following location: /opt/splunk/etc/deployment-apps/Gencsvfromsearch/bin/search_spec.conf Step 3 Edit the search configuration file. Note Host can be host name or IP address. a) Add the values to the following parameters if you want to enable SFTP key-based authentication: • SFTPServer.SFTP.ip = Videoscape Distribution Suite Service Manager User Guide, Release 3.3 137 Analytics Generating CSV Files from Search Results (Gencsvfromsearch) • SFTPServer.SFTP.port = • SFTPServer.SFTP.username = • SFTPServer.SFTP.directory = • SFTPServer.SFTP.keyfile.location = • SFTPServer.SFTP.keyfile. passcode = • SFTPServer.SFTP.keyfile.type = Note When both options are specified (key-based parameter and password-based parameter), key-based authentication is attempted. There will be no fall back to password-based authentication, if the key-based authentication fails. b) Add the values to the following parameters if you want to enable SFTP password-based authentication: • SFTPServer.SFTP.ip = • SFTPServer.SFTP.username = • SFTPServer.SFTP.password = • SFTPServer.SFTP.directory = Note The key file parameters must be empty for password-based authentication. c) Add the values to the following parameters if you want to enable FTP authentication: • [ftpserver] • FTPServer.FTP.ip = • FTPServer.FTP.port = • FTPServer.FTP.username = • FTPServer.FTP.password = • FTPServer.FTP.directory = Note You must ensure that the same parameter values are available in the Secondary Job Scheduler's search_spec.conf in case of ESX failover. The results are exported for the following searches: • HSSBitRate • MobitvBitRate • ABRNumberOfRequestPerSecond • ClientRequests4xxErrorRateonDeliveryServers • ResponseCodebyDeliveryServer • RealtimeEdgeBandwidthUsage Videoscape Distribution Suite Service Manager User Guide, Release 3.3 138 Analytics Generating CSV Files from Search Results (Gencsvfromsearch) • ConcurrentClientSessions • HistoricalEdgeBandwidthUsageForLastDay • HistoricalEdgeBandwidthUsageForLast3Day • HistoricalEdgeBandwidthUsageForLast7Day • HSSBitrateOscillationRateForLastDay • HSSBitrateOscillationRateForLast3Day • HSSBitrateOscillationRateForLast7Day • MobitvBitrateOscillationRateForLastDay • MobitvBitrateOscillationRateForLast3Day • MobitvBitrateOscillationRateForLast7Day • ClientDensitybyNumberofRequestsForLastDay • ClientDensitybyNumberofRequestsLast3Day • ClientDensitybyNumberofRequestsForLast7Day • HLSBitRate • HLSBitrateOscillationRateForLastDay • HLSBitrateOscillationRateForLast3Day • HLSBitrateOscillationRateForLast7Day Run Shell Script The gencsvfromsearch.sh is a wrapper script which is used to execute gencsvfromsearch.py. You must execute gencsvfromsearch.sh script from the Forwarder node. Step 1 Log in to the Forwarder node using the following credentials: Username: bnisplunk Password: <password> Step 2 Navigate to the following location: /opt/splunkforwarder/etc/apps/Gencsvfromsearch/bin Step 3 Execute the script using the following command: sh gencsvfromsearch.sh <Searchname> <Protocol> <FTP/SFTPname> Description of parameters in the above command are: • Search name–This parameter is specified in search section of the search_spec.conf file. • Protocol–This parameter sets the export protocol as FTP/SFTP. • FTP/SFTP name–FTP name is specified in FTP server section and SFTP name is specified in SFTP server section of the search_spec.conf file. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 139 Analytics Generating CSV Files from Search Results (Gencsvfromsearch) Note Depending on the protocol that will be used, you need to provide values for the respective section or stanza in the conf file. Example ./gencsvfromsearch.sh HSSBitRate SFTP SFTP1 Run Python Script The gencsvfromsearch.py script searches from Splunk using the specified search query, generates the CSV file, and then uploads the CSV to the specified SFTP server. You should execute gencsvfromsearch.py script from the Forwarder node. Step 1 Log in to the Forwarder node using the following credentials: Username: bnisplunk Password: <password> Step 2 Navigate to the following location: cd /opt/splunkforwarder/etc/apps/Gencsvfromsearch/bin Step 3 Execute the script using the following command: /opt/splunk/bin/splunk cmd python gencsvfromsearch.py <Searchname> <Protocol> <FTP/SFTPname> Description of parameters in the above command are: • Search name–This parameter is specified in search section of the search_spec.conf file. • Protocol–This parameter sets the export protocol as FTP/SFTP. • FTP/SFTP name–FTP name is specified in FTP server section and SFTP name is specified in SFTP server section of the search_spec.conf file. Example /opt/splunk/bin/splunk cmd python gencsvfromsearch.py HSSBitRate SFTP SFTP1 Videoscape Distribution Suite Service Manager User Guide, Release 3.3 140 CHAPTER 5 Monitor • Monitor Overview, page 141 Monitor Overview CDN hosts different content, such as live and archived, to viewers around the world. For the CDN Operators to quickly check the performance of the network, real-time monitoring is performed on Throughput, Cache Hit Ratio, Concurrent Active Sessions, and Responses. Note Only Throughput, Cache Hit Ratio, Concurrent Active Sessions, and Responses charts are refreshed real-time (with minimum delay). To access this feature, click Monitor from the main page. The following categories are displayed in Monitor: • CDN Overview • Throughput • Cache Hit Ratio • Concurrent Active Sessions • Responses • Bitrates These categories are explained in detail here. CDN Overview Displays the number of delivery services, delivery servers, and edge locations. These values are refreshed every eight minutes. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 141 Monitor Monitor Overview Throughput (Gbps) The following table describes the Throughput chart: Table 108: Throughput Chart & Description Chart Description Throughput Illustrates the data delivered by the network at real-time. Chart Information The information within this chart is shown in a line graph with Date/Time along the X-axis and the throughput in Gbps along the Y-axis. The legends representing the graph are maximum, minimum, and average. Chart Filters This chart uses Delivery Server, and Delivery Service as filters. Cache Hit Ratio Videoscape Distribution Suite Service Manager User Guide, Release 3.3 142 Monitor Monitor Overview The following table describes the Cache Hit Ratio chart: Table 109: Cache Hit Ratio Chart & Description Chart Description Cache Hit Ratio Provides client request cache hit and miss percentage at real-time. Chart Information The information within this chart is shown in a stacked area graph with Date/Time along the X-axis and the cache hit/miss percentage in the Y-axis. The legends representing the graph are Cache Hit and Cache Miss. Chart Filters This chart uses Delivery Server, and Delivery Service as filters. Concurrent Active Sessions Videoscape Distribution Suite Service Manager User Guide, Release 3.3 143 Monitor Monitor Overview The following table describes the Concurrent Active Sessions chart: Table 110: Concurrent Active Sessions Chart & Description Chart Description Concurrent Active Sessions Illustrates the concurrent client sessions at real-time. Chart Information The information within this chart is a line graph with Date/Time along the X-axis and Maximum, Minimum and Average count along the Y-axis. The legends representing the graph are maximum, average, and minimum. Chart Filters This chart uses Delivery Server, and Delivery Service as filters. Responses The following table describes the Responses chart: Table 111: Responses Chart & Description Chart Description Responses Provides response codes count or percentage at real-time. Chart Information The information within this chart is shown in stacked area with Date/Time along the X-axis with the response count or percentage along the Y-axis. The legends representing the graph are 2xx, 3xx, 4xx, and 5xx. Chart Filters This chart uses Delivery Server, and Delivery Service as filters. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 144 Monitor Monitor Overview Bitrates The following table describes the Bitrates chart: Table 112: Bitrates Chart & Description Chart Description Bitrates Illustrates the bitrate used to serve the content through CDN. Chart Information The information within this chart is shown in a column graph with Bitrate along the X-axis and Count along the Y-axis. The bitrate values in the chart are refreshed every minute. Chart Filters This chart uses Delivery Server, and Delivery Service as filters. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 145 Monitor Monitor Overview Videoscape Distribution Suite Service Manager User Guide, Release 3.3 146 CHAPTER 6 Alerts • Alerts Overview, page 147 • Adding a Threshold Alert, page 147 • Deleting a Threshold Alert, page 149 • Customizing Threshold Metrics, page 149 • Quota Violations, page 150 Alerts Overview Alerts are sent in the form of emails and are designed based on the results of your scheduled searches. Alerts highlight the exceptions that occur as a result of exceeding the configured threshold criteria. Adding a Threshold Alert To add a threshold alert, perform the following steps: Step 1 From the Home page, choose Alerts > Thresholds. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 147 Alerts Adding a Threshold Alert The Thresholds page appears. Figure 1: Thresholds page Step 2 Enter the following details in the Thresholds table: Table 113: Adding a Threshold Alert–Field and Description Field Description Alert Condition Choose the condition for which the alert is to be triggered and specify the value. Alert Name Enter the alert name. Email Id Enter the email ID(s) to which the alerts are to be sent. Multiple email IDs can be added separated by commas. Frequency Specify the frequency for triggering the alert emails. The alert will be sent at regular intervals based on the value that you configure in the Frequency field. Step 3 Click Create. The newly added alert appears in the Threshold Alerts table and admin folder in the Custom Search and Reports. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 148 Alerts Deleting a Threshold Alert Deleting a Threshold Alert To delete a threshold alert, perform the following steps: Step 1 Step 2 From the Home page, choose Alerts > Thresholds. The Thresholds page appears. In the Threshold Alerts table, click the Delete button next to the threshold alert that you want to delete. Step 3 Click OK to permanently delete the threshold alert in the confirmation dialog box. Step 4 Close the Success dialog box. Customizing Threshold Metrics VDS-SM provides an option to configure the list of threshold metrics. By default, the Thresholds page lists five metrics such as Peak Throughput, Concurrent Active Sessions, Average Dynamic Storage, 4XX Errors, and 5XX Errors. The CDN Operator can create a new metric and add scheduled alerts for that metric. Note All the alerts related changes are saved under /opt/splunk/etc/apps/CDNAnalytics/local/savedsearches.conf file and related metadata information are stored under /opt/splunk/etc/apps/CDNAnalytics/metadata/local.meta file. Before making any changes to the CDNAnalytics app, take backup of /opt/splunk/etc/apps/CDNAnalytics/local/savedsearches.conf and /opt/splunk/etc/apps/CDNAnalytics/metadata/local.meta files. To create a Threshold metric, perform the following steps: Step 1 Log in to the Search Head node using the following credentials: Username: bnisplunk Password: <password> Step 2 Navigate to the following location: /opt/splunk/etc/apps/CDNAnalytics/local/ Step 3 Open the thresholds_Alerts.conf file. thresholds_Alerts.conf file contains a list of codes as stanzas corresponding to the metrics listed in the Thresholds page. Step 4 Add the search query. Provide the appropriate attributes such as alert_condition, search_15mnts, search_1hr and search_1day in the query. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 149 Alerts Quota Violations Note • In the search query, use the pattern "$%operator%$" instead of comparison operator and "$%thresholdValue%$" instead of comparison value. • You can add footer to the alert mails by replacing ". " with the custom message for footer_Text option, in thresholds_alerts.conf file. The newly added metric appears in the Thresholds page. Note After adding a new metric, replace the existing savedsearches.conf file with savedsearches.conf back up file in the SH node. Quota Violations VDS-IS allows the Operator to set quota limits for Bandwidth, Storage, and Sessions at the delivery service level. The CDN still caters the service to the providers when they exceed the quota limit (depending on buffer). When the quota limit is exceeded, alerts are triggered. From the main page, choose Alerts > Quota Violations. This displays the Bandwidth, Session, and Storage alerts. Bandwidth Alerts Chart Description Bandwidth Alerts Illustrates all bandwidth alerts that are triggered. Filter This chart uses Provider, Delivery Service, and the Time Range Picker as filters. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 150 Alerts Session Alerts Session Alerts Chart Description Session Alerts Illustrates all session alerts that are triggered. Filter This chart uses Provider, Delivery Service, and the Time Range Picker as filters. Storage Alerts Chart Description Storage Alerts Illustrates all storage alerts that are triggered. Filter This chart uses Provider, Delivery Service, and the Time Range Picker as filters. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 151 Alerts Storage Alerts Videoscape Distribution Suite Service Manager User Guide, Release 3.3 152 CHAPTER 7 Configuration • VDS Manager Configuration, page 153 • Adding a CDN, page 154 • Managing a VDS-IS CDN, page 155 • Distribution Hierarchy Function Overview, page 157 • Delivery Servers, page 159 • URL Signing, page 159 • Delivery Services, page 164 • Reseller Function Overview, page 167 • Content Provider Function Overview, page 170 • Services, page 174 • Geo Fencing, page 176 • Content Purging, page 178 VDS Manager Configuration VDS Manager enables CDN Operators to deploy and manage the VDS-IS configuration such as delivery services. Multi-Tiered and Multi-Tenancy The Operator can manage the simple profile (name, contact info, and quota) users for content providers (CP) and Resellers. Once a CP or Reseller user is created, the newly created user can log in and view its own dashboards. The VDS Operator can manage the hierarchical relationship among CDN, CP, and Services. The CP or Reseller user can view dashboards at the Delivery Service level for all Delivery Services under its domain. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 153 Configuration Adding a CDN Services (1-to-1 with Delivery Service) are synchronized from the Content Delivery Service Manager (CDSM) periodically. All Delivery Services should be synchronized from the CDSM to the VDS Manager, including both live and VOD Content Delivery Services. Adding a CDN To deploy VDS-SM, you must configure CDN. CDN enables VDS-SM to gather topology information from the Service and allows the service to be controlled by the VDS-SM solution. To add a CDN, perform the following steps: Step 1 Step 2 From the main page, choose Configuration > CDN. The CDN page, listing all configured CDN devices and their status is displayed. Click to create a new CDN. In the Create CDN popup, enter the appropriate CDN information for the VDS-IS CDSM as mentioned here. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 154 Configuration Managing a VDS-IS CDN Table 114: Create CDN Field & Description Field Description Name A unique name for the device. Provider The content provider for this CDN. Device Address The IP address or Fully Qualified Domain Name (FQDN) of this device. Control Port A pre-existing port number specified for this device. Contact your System Administrator for this information. Location The location to which this device is associated. Service State The service state of the service: • In Service: Enables the service. When a device is in this state, all read and write operations to this device are allowed. • Out of Service: Disables the service. When a device is in this state, all write operations are not allowed. However, the read operation is still allowed, whereby the periodic sync, operational state check, and manual sync will still happen. Username The user name associated with the device. Password/Confirm Password The password associated with the username for this CDN service. Description Optional. User defined description for the CDN service. Step 3 On completion, click Create. The CDN is created and a validation message is displayed. Step 4 Click Close. Step 5 From within the CDN screen, click Refresh to view the newly added CDN service. Note that the CDN synchronization will take a few minutes. Managing a VDS-IS CDN To manage a VDS-IS CDN, perform the following steps: Step 1 From the main page, choose Configuration > CDN. Step 2 Click the arrow next to the name of the CDN you want to manage. The Distribution Hierarchy maps to the CDSM location. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 155 Configuration Managing a VDS-IS CDN The following table provides a description of the key elements contained within the selected CDN page. Table 115: CDN - Field & Description Element Description Distribution Hierarchy The Distribution Hierarchy maps to CDSM locations (see Distribution Hierarchy Function Overview, on page 157). Service Routers The VDS-SM Service Routers map to the CDSM devices (SRs). Delivery Servers The VDS-SM Delivery Servers map to the CDSM devices (SEs) (see Delivery Servers, on page 159). Delivery Services The VDS-SM Delivery Services map to the CDSM Delivery Services (see Delivery Services, on page 164). Videoscape Distribution Suite Service Manager User Guide, Release 3.3 156 Configuration Distribution Hierarchy Function Overview Distribution Hierarchy Function Overview Adding a Distribution Hierarchy To add a Distribution Hierarchy, perform the following steps: Step 1 From the main page, choose Configuration > CDN. Step 2 Select the CDN to which you want to add Distribution Hierarchy and click Step 3 Step 4 . In the Distribution Hierarchy tab, click . In the dialog box that appears in the right pane, enter the following details: Table 116: Adding Distribution Hierarchy - Field & Description Field Description Name Specify the Server Group name. Parent Server Group Specify the Parent Server Group. Topology Location Specify the Topology Location. Level Specify the level to which the Delivery Server belongs. Description Optional. Additional information about the Distribution Hierarchy. Step 5 Click OK. Step 6 Click Save. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 157 Configuration Modifying a Distribution Hierarchy Modifying a Distribution Hierarchy To modify a Distribution Hierarchy, perform the following steps: Step 1 From the main page, choose Configuration > CDN. Step 2 Select the CDN that you want to modify and click . Step 3 Step 4 From the Distribution Hierarchy tab, select the Distribution Hierarchy that you want to modify and click Edit the details in the dialog box that appears on the right pane and click OK. Step 5 Click Save. . Cloning a Distribution Hierarchy This feature helps you to replicate an existing Distribution Hierarchy. This is helpful when you want to create the same Distribution Hierarchy again. To clone a distribution hierarchy, perform the following steps: Step 1 From the main page, choose Configuration > CDN. Step 2 Select the CDN that you want to clone and click . Step 3 From the Distribution Hierarchy tab, select the Distribution Hierarchy, which you want to clone and click Step 4 Step 5 Click . and then click OK. Click Save. Deleting a Distribution Hierarchy To delete a Distribution Hierarchy, perform the following steps: Step 1 Step 2 From the main page, choose Configuration > CDN. From the Distribution Hierarchy tab, select the Distribution Hierarchy that you want to delete and click Videoscape Distribution Suite Service Manager User Guide, Release 3.3 158 . Configuration Delivery Servers You can also undo a task that you have just performed. This option is not feasible for an existing Delivery Hierarchy. For example, you can undo a Distribution Hierarchy, immediately after it has been added. For this, select the task that you want to undo (the task that you just performed), and click . Delivery Servers Modifying a Delivery Server To modify a Delivery Server, perform the following steps: Step 1 From the main page, choose Configuration > CDN. Step 2 Select the CDN that you want to modify and click . Step 3 Step 4 Step 5 In the Delivery Servers tab, select the Delivery Server that you want to modify and click Edit the details and click OK. . Click Save. Note You can only edit the Description and Server Group fields. URL Signing Cisco Internet Streamer CDS provides the option for signing and validating content URLs, thus restricting access to some users and limiting the viewing time. For signing and validating the URL, the CDS rely on a set of one or more secret keys shared among the portal and the devices within CDS. This information needs to be configured on the participating Service Engines by the CDN Operator. To access this feature, perform the following steps: Step 1 Step 2 Step 3 From the main page, choose Configuration > CDN. The CDN page is displayed. Click , which is located next to the CDN. In the Delivery Servers tab, click . Videoscape Distribution Suite Service Manager User Guide, Release 3.3 159 Configuration URL Signing Step 4 The following URL Signing page is displayed. Table 117: URL Signing Parameters Column Name Description Key Id Owner Specify the ID number for the owner of this encryption key. Valid entries are from 1 to 32. Key Id Number Specify the encryption key ID number. Valid entries are from 1 to 16. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 160 Configuration URL Signing Column Name Description Key Field for Symmetric Key only. Enter a unique URL signature key with up to 16 characters (excluding double quotes at the beginning and end of the string). This field accepts only 7-bit printable ASCII characters (alphabetic, numerics, and others) and does not support a space or the following special characters: pipe (|), question mark (?), double quotes ("), and apostrophe (’). The following special characters are allowed: {}!#$%&()*+,-./;:<=>@\~^[]_ Quoted and unquoted strings are allowed. Double quotes (") are allowed at the beginning and end of the string only. If you do not surround the key string with double quotes, quotes are added when you click Submit. Public Key URL Field for Asymmetric Key only. The location of the public key file. Only HTTP, HTTPS, or FTP addresses are supported. The public/private key pair is stored in Privacy Enhanced Mail (PEM) format. Note During Validation, the public key file is checked if the file size exceeds 2000 bytes and if the file starts with "-----BEGIN PUBLIC KEY-----" and contains "-----END PUBLIC KEY-----" line Private Key URL Field for Asymmetric Key only. The location of the private key file. Only HTTP, HTTPS, or FTP addresses are supported. The public/private key pair is stored in Privacy Enhanced Mail (PEM) format. Note During Validation, the private key file is checked if the file size exceeds 2000 bytes and if the file starts with "-----BEGIN EC PRIVATE KEY-----" and contains "-----END EC PRIVATE KEY-----" line Symmetric Key Field for Asymmetric Key only. A 16-byte American Encryption Standard (AES) key used for AES encryption of the signed URL. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 161 Configuration Creating URL Signature Creating URL Signature To create a URL Signature, perform the following steps: Step 1 From the main page, choose Configuration > CDN. The CDN page is displayed. Step 2 After navigating to the URL Signing page, click Step 3 Enter the details as mentioned in the following table: . Field Description Cryptographic Algorithm Choose either Symmetric Key or Asymmetric Key. For all other field information, refer to the Table 117: URL Signing Parameters, on page 160. Click Submit. Note Step 4 Editing URL Signature To edit a URL Signature, perform the following steps: Step 1 From the main page, choose Configuration > CDN. The CDN page is displayed. Step 2 After navigating to the URL Signing page, select the URL Signature information, which you want to edit. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 162 Configuration Deleting URL Signature Step 3 Step 4 Click . Enter the required changes and click Submit. Note For Asymmetric Key, only Private Key URL and Symmetric Key fields can be edited. For Symmetric Key, only the Key field can be edited. Deleting URL Signature To delete a URL Signature, perform the following steps: Step 1 From the main page, choose Configuration > CDN. The CDN page is displayed. Step 2 Step 3 After navigating to the URL Signing page, select the URL Signature information, which you want to delete. Step 4 Click . Click Yes in the Confirmation dialog box. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 163 Configuration Delivery Services Delivery Services Adding a Delivery Service To add a Delivery Service, perform the following steps: Step 1 From the main page, choose Configuration > CDN. Step 2 Select the CDN to which you want to add a Delivery Service and click Step 3 Step 4 On the Delivery Services tab, click . . Enter the following details in the Create Delivery Service dialog box: Table 118: Adding Delivery Service - Field & Description Field Description Name Specify the Delivery Service name. Origin FQDN Specify the FQDN of the Content Provider. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 164 Configuration Adding a Delivery Service Field Description Preposition Storage Quota (MB) Maximum content disk storage size for each SE, in megabytes, for pre-fetched content and metadata, and hybrid metadata for this delivery service. The default value is zero, which means unlimited storage can be done for this delivery service. Note The configured Preposition Storage Quota does not affect cache content quota size; it only restricts pre-fetched content storage for each SE. If the total pre-fetched content storage size is less than the configured quota, then the extra storage is used for dynamic cache files. Skip Encryption for Distribution Specify whether you need to skip encryption for distribution. Select No for encryption and Yes to skip encryption. Session Quota Maximum number of concurrent sessions allowed for this delivery service. The default value is zero, which means unlimited sessions can be set for this delivery service. Session Quota Augment Buffer (%) Buffer, as a percentage, of the maximum number of concurrent sessions allowed over the Session Quota. If this threshold is exceeded, no new sessions are created until the number of concurrent sessions is below this threshold. The range is from 0 to 1000. The default is 10. Bandwidth Quota (kbps) Maximum bandwidth allowed for this delivery service. The default value is zero, which means unlimited bandwidth can be set for this delivery service. Content Delivery QoS This is automatically set as default. Service Routing Domain Specify the Service Routing Domain Name. Bandwidth Quota Augment Buffer (%) Buffer, as a percentage, of the maximum bandwidth allowed over the Bandwidth Quota. If this threshold is exceeded, no new sessions are created until the bandwidth used is below this threshold. The range is from 0 to 1000. The default is 10. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 165 Configuration Adding a Delivery Service Field Description Is Live When checked, creates a live program to distribute live or scheduled programs to the SEs associated with this delivery service and with the live program. This delivery service does not have a related Manifest file and cannot be used to distribute file-based content as regular delivery services do. The live program learns about a live stream through a program file that describes the attributes of the program. Checking this check box disables the Delivery Service Quota field and fields in the Acquisition and Distribution Properties section. Storage Priority Class Choose the correct option from the drop-down list. Note This is configured in VDS-IS and is synced automatically. Content Provider Associate the delivery service with the content provider. Description Optional. Additional information about the Delivery Service. Step 5 Click Create. Step 6 Verify that the Delivery Service has been created successfully by selecting Delivery Services within the CDN page and then verifying that the newly created Delivery Service is present. Step 7 Click next to the newly created delivery service to associate delivery servers to it. Step 8 Step 9 Display a list of available delivery servers by clicking . Select one or multiple delivery servers that will be associated to the delivery service. Then, select the delivery server, which will be the Content Acquirer, from the drop-down list and then click OK. The Content Acquirer can be changed at any time from the main Delivery Service configuration page, using the Assign Content Acquirer icon. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 166 Configuration Deleting a Delivery Service Deleting a Delivery Service To delete a delivery service, perform the following steps: Step 1 From the main page, choose Configuration > CDN. Step 2 Select the CDN that you want to delete and click . In the Delivery Services tab, select the Delivery Service that you want to delete. Step 3 Step 4 Click and in the confirmation dialog box, click Yes to permanently delete the Delivery Service, and click No to cancel the deletion. Reseller Function Overview A reseller is a user who buys delivery services from CDN and sells to the content providers. A reseller is allocated a specific session bandwidth storage quota. Adding a Reseller To add a reseller, perform the following steps: Step 1 Step 2 From the main page, choose Configuration > Customers > Reseller. Click to open the Create Reseller dialog box. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 167 Configuration Adding a Reseller Adding a Reseller involves configuring or modifying the following fields: Table 119: Adding a Reseller - Field & Description Field Description Reseller Name Specify a unique name for the reseller. Reseller Id Specify the ID for the reseller. Address Specify the IP address or FQDN of this reseller. Phone Specify the phone number for the reseller. Email Specify the email address for the reseller. Website Specify the web site URL for the reseller. Description Optional. Additional information about the reseller. Preposition Storage Quota (MB) Specify the maximum data in MB that can be prepositioned for the reseller. The default value is zero, which means unlimited storage can be done for this reseller. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 168 Configuration Modifying a Reseller Step 3 Field Description Session Quota Specify the maximum number of sessions that can be active for the reseller. The default value is zero, which means unlimited sessions can be set for this reseller. Bandwidth Quota (Kbps) Specify the maximum bandwidth allowed for the reseller. The default value is zero, which means unlimited bandwidth can be set for this reseller. User Name Specify a user name associated with the reseller. Password Specify the user's password associated with this reseller. Confirm Password Re-enter the user's password associated with this reseller. Click Create to add the Reseller. Modifying a Reseller To modify a Reseller, perform the following steps: Step 1 From the main page, choose Configuration > Customers > Reseller. Step 2 Step 3 Select the Reseller that you want to modify and click On the left pane, edit the details and click Save. . Deleting a Reseller To delete a Reseller, perform the following steps: Step 1 Step 2 Step 3 From the main page, choose Configuration > Customers > Reseller. Select the Reseller that you want to delete and click . Click Yes to permanently delete the Reseller, and click No to cancel the deletion. Note • Ensure that you have deleted the Content Provider(s) associated with the Reseller before deleting the Reseller. • When you delete a Reseller, its corresponding user(s) will also be deleted. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 169 Configuration Content Provider Function Overview Content Provider Function Overview A content provider is a user who buys delivery services from CDN and serves the content. Adding a Content Provider To add a content provider, perform the following steps: Step 1 Step 2 From the main page, choose Configuration > Customers > Content Provider. Click to open the Create Content Provider dialog box. Adding a Content Provider involves configuring or modifying the following fields: Videoscape Distribution Suite Service Manager User Guide, Release 3.3 170 Configuration Mapping a Content Provider and Delivery Service Table 120: Adding a Content Provider - Field & Description Field Description Provider Name Specify a unique name for the content provider. Provider Id Specify the ID for the content provider. Address Specify the IP address or FQDN of this content provider. Phone Specify the phone number for this content provider. Email Specify the email address for this content provider. Website Specify the web site URL for this content provider. Description Optional. Additional information about the content provider. Preposition Storage Quota (MB) Specify the maximum data in MB that can be prepositioned for the reseller. The default value is zero, which means unlimited storage can be done for this content provider. Session Quota Specify the maximum number of sessions that can be active for the reseller. The default value is zero, which means unlimited sessions can be set for this content provider. Bandwidth Quota (Kbps) Specify the maximum bandwidth allowed for the reseller. The default value is zero, which means unlimited bandwidth can be set for this content provider. User Name Specify a user name associated with the content provider. Password Specify the user's password associated with this content provider. Confirm Password Re-enter the user's password associated with this content provider. A Content Provider that is not a global Content Provider, will be available under the Reseller option. To view the Reseller option, uncheck Global Content Provider. From the Reseller drop-down, choose the Reseller, which you want to associate the Content Provider to. Step 3 Click Create to add the Content Provider. Mapping a Content Provider and Delivery Service To map a Content Provider and Delivery Service, perform the following steps: Videoscape Distribution Suite Service Manager User Guide, Release 3.3 171 Configuration Assigning Multiple Content Providers to a Single Delivery Service Before You Begin Before you map a Content Provider and Delivery Service, you need to first create the Delivery Service in CDN. For this, you need to add a CDN (see Adding a CDN, on page 154). After you add a CDN, you need to add a Delivery Service (see Adding a Delivery Service, on page 164). Step 1 From the main page, choose Configuration > Customers > Content Provider. Step 2 Select the Content Provider that you want to assign Delivery Service, and click Step 3 Click Step 4 Step 5 . and select the Delivery Service that you need to map. Select the CDN that you want to map and click . Click Save. If you want to assign multiple Content Providers to a single Delivery Service, you must not map Content Provider and Delivery Service. Assigning Multiple Content Providers to a Single Delivery Service This feature enables the user to set up multiple Content Providers to a single Delivery Service. This is feasible by providing a custom Regex option, wherein the CDN Operator can provide the Regex for new field CP_ID. This custom regex is used to extract CP_ID from the URL and then perform a lookup to get a meaningful CP name. If the CDN Operator needs to use Asset ID to obtain meaningful CP name, then the Asset ID and CP_ID will have the same Regex for token extraction from the URL. CDN Operators can either create or update Regex for CP_ID extraction. Regex is maintained in props.conf, a Splunk configuration file. To create or update Regex for CP_ID, perform the following steps: Step 1 Log in to the analytics JS node using the following credentials: Username: bnisplunk Password: password Step 2 Execute the script configure_regex.py using the following command to add/update: $SPLUNK_HOME/bin/splunk cmd python $SPLUNK_HOME/etc/apps/CDN_JS/bin/configure_regex.py add <sourcetype> <fieldname> "<regex>" Where, <sourcetype> is the sourcetype for which the regex is provided. The valid source types are: fms_disconnect, wmt_logplaystats, we_access, abr_session and sr_transaction <regex>—regex to extract the Content Provider information from the log data <fieldname>—the valid field names are CP_ID and Asset Example: For the following log file entry: Videoscape Distribution Suite Service Manager User Guide, Release 3.3 172 Configuration Modifying a Content Provider [28/Nov/2012:23:54:42.315+0000] 1799 74.126.71.217 TCP_HIT/206 2458 GET http://ccp-cmc-smooth-localpod02linear.cdn2.net/content/CP1/hls/file0/file_500.m3u8 application/x-mpegURL - hls 0 - 20121129100000000100000001 [29/Nov/2012:00:00:02.317+0000] External – Case1: If you want to extract content/CP1 as CP_ID, then the Regex is: (?i)^(?:[^ ]*( {1,2})){6}(?:[a-z]+://)(?:[^ /:]+[^ /]+/)(?P<CP_ID>[^ /]+/[^ /]+) Case 2: If you want to extract CP1 as CP_ID, then the Regex is: (?i)^(?:[^ ]*( {1,2})){6}(?:[a-z]+://)(?:[^ /:]+[^ /]+/[^ /]+/)?(?P<CP_ID>[^ /]+) Case 3: If you want to extract file_500.m3u8 as Asset, then the Regex is: (?i)^(?:[^ ]*( {1,2})){6}(?:[a-z]+://)(?:[^ /:]+[^ /]+/[^ /]+/[^ /]+/[^ /]+/[^ /]+/)(?P<Asset>[^ ]+) Once this script is executed, redeployment of the server is initiated automatically. To delete Regex for CP_ID, use the following command: #$SPLUNK_HOME/bin/splunk cmd python configure_regex.py <remove> <sourcetype> <fieldname> Modifying a Content Provider To modify a Content Provider, perform the following steps: Step 1 From the main page, choose Configuration > Customers > Content Provider. Step 2 Step 3 Select the Content Provider that you want to modify and click In the left pane, edit the details and click Save. . Deleting a Content Provider To delete a Content Provider, perform the following steps: Step 1 Step 2 Step 3 From the main page, choose Configuration > Customers > Content Provider. Select the Content Provider that you want to delete and click . Click Yes to permanently delete the Content Provider, and click No to cancel deletion. Note When you delete a Content Provider, its corresponding user(s) will also be deleted. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 173 Configuration Services Services This feature provides a quick overview of the bandwidth, session, and storage quota for each reseller, content provider, and delivery service in the CDN to the CDN Operator. These quotas need to be specified when you create delivery service, content provider, and reseller. To access this feature, from the main page, click Configuration > Services. On the right pane, the overall CDN Operator allocation is displayed as a pie chart. To view the bandwidth, session, and storage quota for each reseller, on the left pane, click the arrow next to the CDN Operator. The resellers under the CDN Operator are displayed. Select a specific reseller to view the allocation. Note For unlimited bandwidth, session, or storage quota, the pie chart will not be displayed. To view the bandwidth, session, and storage quota of each content provider, on the left pane, click the arrow next to the respective reseller. The content providers under the resellers are displayed. Select a specific content provider to view the allocation. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 174 Configuration Services To view the delivery services of each content provider, on the left pane, click the arrow next to the respective content provider. The delivery services under the content providers are displayed. Note Utilization shown in the data grid is the actual CDN utilization. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 175 Configuration Geo Fencing Geo Fencing A Geo/IP file is an XML file that configures the delivery service to allow or deny client requests, based on the client’s IP address or client’s geographic locations (country, state, city). Each Service Engine participating in the Authorization Service must have Authorization Service enabled and the IP address and port of the Geo-Location server specified. VDS-IS provides an option to apply Geo/IP file and restrict access to the content, based on location. Geo Fencing enables the Content Providers and CDN Operators to assign a Geo IP file to a delivery service or to disassociate a Geo IP file from a delivery service. Assigning a Geo/IP file to a Delivery Service To assign a Geo IP file to a delivery service, perform the following steps: Step 1 From the main page, choose Configuration > Geo Fencing. Step 2 Choose the CDN from the Select CDN drop-down list. Step 3 Click Browse next to Geo/IP File Upload text box to select the Geo IP file. The Geo IP file is an XML file. Step 4 Click Validate to validate the selected Geo IP file. This displays the details on the right pane. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 176 Configuration Disassociating a Geo/IP file from a Delivery Service Step 5 Step 6 Step 7 The Destination File Name is auto populated when you select a Geo IP file. If the users want to edit, they can edit as desired. Choose the delivery service from the Apply to Delivery Service drop-down list to which the file needs to be assigned to. Click Submit. The Geo IP file will be associated with the delivery service successfully. Disassociating a Geo/IP file from a Delivery Service To disassociate a Geo IP file associated with a delivery service, perform the following steps: Step 1 From the main page, choose Configuration > Geo Fencing. Step 2 Choose the delivery service from the Apply to Delivery Service drop-down list. Step 3 Click Delete. This will disassociate the Geo IP file from the selected delivery service and this deletes the file from the system. Note To delete a Geo IP file, the file should not be associated with any delivery services. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 177 Configuration Content Purging Content Purging Content purging enables the wholesale users (both the Resellers and Content Providers) to delete the dynamically cached content from the delivery servers that deliver content through the delivery services assigned to them. By default, all content deletion requests will be sent as synchronous requests. To send requests that have wildcard characters in a URL as asynchronous, add the following configuration in Global Configurations after choosing cdnmanager from the Property View drop-down list Deleting Content To delete the content, perform the following steps: Step 1 From the main page, choose Configuration > Content Purging. This shows the deletion tasks table where the tasks for deletion requests are created. Table 121: Deletion Tasks Table Column Name Description Created Date Date on which content deletion request is created on VDS-IS. Type Two types namely API and GUI. • API—Tasks created through VDS-SM by using REST APIs that are exposed by VDS-IS. • CDSM GUI—Tasks created through VDS-IS GUI. Total SEs Videoscape Distribution Suite Service Manager User Guide, Release 3.3 178 Total number of Service Engines to which the deletion request is sent. Configuration Deleting Content Completed SEs Number of Service Engines in which the deletion request is completed. Status Status of deletion task. Comment Comments given at the time of deletion request. When you click Step 2 Click , the Task Result page is displayed. This displays the content deletion request details. to open the Content Deletion dialog box. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 179 Configuration Deleting Content Step 3 Choose the CDN from the Select CDN drop-down list. Step 4 Enter the content URL in the Content URL text box. By entering the content URL, the Delivery Server(s) field will be populated with the delivery servers associated with the delivery services that serve the given content URL. Enter the comments in the Comments text box. Step 5 Step 6 Step 7 Select the desired delivery server(s) from the Delivery Server(s) field from which the content needs to be deleted. If no delivery servers are selected, then the content will be deleted from all delivery servers that are associated with the delivery services that serve the given content. Click Submit. The content from the selected delivery server(s) will be deleted successfully and the deletion details will be included in the deletion tasks table. By clicking the Refresh icon, the content deletion task table is refreshed. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 180 CHAPTER 8 Administration • System Load Dashboard, page 181 • License Usage , page 183 • Managing Users and Roles Overview, page 184 • About User Accounts, page 184 • Roles, page 185 • Global Configurations, page 186 • CDN Health, page 188 • Log Event Discrepancies, page 211 System Load Dashboard Displays charts that represents Percent Load by Host, Percent Memory Used by Host , Disk Used by Host and Volume, and Interface Throughput, across the nodes in the system. To access System Load Dashboard, from the main page, choose Administration > System Load Dashboard. Percent Load by Host Videoscape Distribution Suite Service Manager User Guide, Release 3.3 181 Administration System Load Dashboard Percent Memory Used by Host Disk Used by Host and Volume Videoscape Distribution Suite Service Manager User Guide, Release 3.3 182 Administration License Usage Interface Throughput License Usage The License Usage dashboard displays the amount of logs indexed in the system. To access the License Usage dashboard, from the main page, choose Administration > License Usage. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 183 Administration Managing Users and Roles Overview The following table describes the chart available within this dashboard. Table 122: License Usage Chart & Description Chart Description License Usage Illustrates the amount of logs indexed in the system. Chart Information The information within this chart is shown as a line graph with the Date/Time along the X-axis and the License Usage in GB along the Y-axis. The legends representing the graph are by total data Delivered and GB data indexed. Chart Formula The formula used to derive the graph is: total log files indexed in the system vs. the total data delivered within the CDN. Chart Filters Note This chart uses Time Range Picker - Last 7 days, Last 30 days, Last 90 days, Last 365 days, and Custom time, as filters. You can configure the group ID and label in the common.conf file according to your splunk license. The common.conf file is available in the Job Scheduler node at the following location: /opt/splunk/etc/deployment-apps/appnormalize/bin Depending on the configuration made in the common.conf file, the License Quota value will vary. Managing Users and Roles Overview Administrators can create specific users and set their roles from the User Management page. To access User Management, from the main page, choose Administration > User Management. In this feature, you can add and delete a user. About User Accounts User accounts define user roles and access privileges to system configuration and management functional areas. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 184 Administration Roles The CDN Manager includes a default user profile with Cisco Administrator access privileges, to provide the Network Administrator first-time access to the CDN Manager system. Administrator privileges provide full rights to all system functions. You must have Administrator privileges to define roles and grant access permissions to system functions. Note For added security, we recommend that you replace the Cisco Administrator account with a new Administrator user account, specific to only your network management. Roles A user's role dictates the functional area and level of access that is granted to the user. Following is a list of the supported roles: • CDN Operator Administrator • CDN Operator Viewer • Reseller Administrator • Reseller Viewer • Content Provider Administrator • Content Provider Viewer Adding a User Adding a user involves: • Creating the user • Defining the user's role Note You must have Administrator rights to add a user. To add a user, perform the following steps: Step 1 From the main page, choose Administration > User Management. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 185 Administration Deleting a User Step 2 Step 3 Step 4 Step 5 Click to add the user and define the user's role. In the Create New User dialog, type the values in the fields or select an option from the drop-down list. Add the user's name and password. By default, the role is set to Admin. Click Create. Deleting a User To delete a user, perform the following steps: Step 1 From the main page, choose Administration > User Management. Step 2 Step 3 From the User Management page, select the user you want to delete. Step 4 Click . Click Yes in the confirmation dialog box. The user will be deleted. Global Configurations Configuration includes any settings that exist on an Appliance, which an end-user might modify in the following ways: • Using the Appliance Agent (rAPA) User Interface (UI) or Manager User Interface • A manual edit to a specific file using a documented procedure; for example, file system modification of jboss-log4j.xml or workflows • By copying a modified file onto the appliance from elsewhere Important! Modifying a Global Configuration can have a major impact on the running system. A parameter change should only be made by a System Administrator who has a detailed understanding about the impact of the change on the running system. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 186 Administration Adding Global Configurations A baseline configuration is established at the conclusion of installing each appliance. Any parameters not mentioned in this document (for example, tty device definitions) should be considered non-modifiable. The following lists the configuration parameter elements: • Configuration Elements: Kinds of configuration settings used by the system; for example, topology or configuration database, workflow, and so on. • Appliance Configuration Parameters: Summary of all parameters used in configuring appliances with description, value type, and so on. • Solution Node Settings: Settings recorded on each node, which define that node's specific role in the overall solution. • Global Configuration Settings: Globally visible configuration sections, each containing a description of all parameters in the section, including the product defaults. • System Topology: Topology data and its usage, import/export operations and the export schema. • Configuration Files: Essential files for each appliance that contain the configuration for the appliance. To access Global Configurations, choose Administration > Global Configurations. Adding Global Configurations To add global configurations, perform the following steps: Step 1 Step 2 Step 3 From the main page, choose Administration > Global Configurations. Click to add global configurations. Enter the details and click OK and then click Save. Deleting Global Configurations To delete global configurations, perform the following steps: Step 1 From the main page, choose Administration > Global Configurations. Step 2 Step 3 Select the Global configuration you want to delete. Step 4 Click . Click OK and then click Save. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 187 Administration CDN Health CDN Health Monitoring the health of CDN network can help prevent the CDN network from getting to a state in which your users cannot access the network or the data on it. VDS-SM provides an option to monitor the health of the CDN network resources in real-time and as trends. The following categories are displayed in CDN Health: • Monitor • Trend Enabling Service Monitor Transaction Log CDN Health charts will be displayed only when the Service Monitor transaction log is forwarded from VDS-IS to VDS-SM. Enabling Service Monitor (SE) Transaction Log To enable and export Service Engine transaction log, perform the following steps: Note You can perform the below steps only if you have installed VDS-IS version that supports Service Monitor functionality. Step 1 Step 2 Login to the CDSM UI. Click Devices and select the required Service Engine. Step 3 In the right pane, choose Service Control > Transaction Logging. Step 4 From Monitors table, check the Service Monitor check box. Step 5 Click Submit. Enabling Service Monitor (SR) Transaction Log To enable and export Service Router transaction log, perform the following steps: Videoscape Distribution Suite Service Manager User Guide, Release 3.3 188 Administration Monitor Note You can perform the below steps only if you have installed VDS-IS version that supports Service Monitor functionality. Step 1 Step 2 Login to the CDSM UI. Click Devices and select the required Service Router. Step 3 In the right pane, choose General Settings > Notification and Tracking > Transaction Logging. Step 4 From Monitors table, check the Service Monitor check box. Step 5 Click Submit. Monitor Monitor dashboard displays metrics indicating the health of system resources in real-time. To access the Monitor dashboard, from the Home page, choose Administration > CDN Health > Monitor. The following parameters are displayed in the Monitor dashboard: • CPU Usage • Memory Usage • Disk Usage • CPU Usage by Protocol Engines • Memory Usage by Protocol Engines • Stopped Protocol Engines • Threshold Exceeded Protocol Engines Videoscape Distribution Suite Service Manager User Guide, Release 3.3 189 Administration Monitor CPU Usage The following table describes the CPU Usage chart: Table 123: CPU Usage Chart & Description Chart Description CPU Usage Illustrates the percentage of CPU consumed by a delivery server in real-time. Chart Information The information within this chart is shown in an area graph with Date/Time along the X-axis and the CPU usage as Percentage along the Y-axis. The legend representing the graph is Average. Chart Filters This chart uses Delivery Server as a filter. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 190 Administration Monitor Memory Usage The following table describes the Memory Usage chart: Table 124: Memory Usage Chart & Description Chart Description Memory Usage Illustrates the percentage of memory consumed by a delivery server in real-time. Chart Information The information within this chart is shown in an area graph with Date/Time along the X-axis and the memory usage as Percentage along the Y-axis. The legend representing the graph is Average. Chart Filters This chart uses Delivery Server as a filter. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 191 Administration Monitor Disk Usage The following table describes the Disk Usage chart: Table 125: Disk Usage Chart & Description Chart Description Disk Usage Illustrates the percentage of disk consumed by a delivery server in real-time. Chart Information The information within this chart is shown in an area graph with Date/Time along the X-axis and the disk usage as Percentage along the Y-axis. The legend representing the graph is Average. Chart Filters This chart uses Delivery Server as a filter. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 192 Administration Monitor CPU Usage by Protocol Engines The following table describes the CPU Usage by Protocol Engines chart: Table 126: CPU Usage by Protocol Engines Chart & Description Chart Description CPU Usage by Protocol Engines Illustrates the percentage of CPU consumed by the protocol engines of a delivery server in real-time. Chart Information The information within this chart is shown in a line graph with Date/Time along the X-axis and the CPU usage as Percentage along the Y-axis. The legends representing the graph are protocol engines. Chart Filters This chart uses Delivery Server as a filter. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 193 Administration Monitor Memory Usage by Protocol Engines The following table describes the Memory Usage by Protocol Engines chart: Table 127: Memory Usage by Protocol Engines Chart & Description Chart Description Memory Usage by Protocol Engines Illustrates the memory consumed by the protocol engines of a delivery server in real-time. Chart Information The information within this chart is shown in a line graph with Date/Time along the X-axis and the memory usage as MB along the Y-axis. The legends representing the graph are protocol engines. Chart Filters This chart uses Delivery Server as a filter. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 194 Administration Monitor Stopped Protocol Engines The following table describes the information in the table: Table Description Stopped Protocol Engines Illustrates whether the protocol engines were fully functional without any stoppages in a given minute. • Red—Protocol Engine stopped at least once. • Green—Protocol Engine was fully functional. Table Information The information within this table are -time, and protocol engines. Table Filters This table uses Delivery Server as a filter. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 195 Administration Trend Threshold Exceeded Protocol Engines The following table describes the information in the table: Table Description Threshold Exceeded Protocol Engines Indicates whether the protocol engines exceeded the thresholds in a given minute. • Red—Threshold exceeded at least once. • Green—Below the threshold. Table Information The information within this table are -time, and protocol engines. Table Filters This table uses Delivery Server as a filter. Trend This features allows you to view the health of system resources based on the historical data (up to seven days) gathered. The following tabs are displayed in Trend: • Service Engine • Service Router Service Engine This tab displays charts that indicates the health of system resources at service engine level. To access this tab, from the Home page, choose Administration > CDN Health > Trend > Service Engine. The following metrics are displayed here: Videoscape Distribution Suite Service Manager User Guide, Release 3.3 196 Administration Trend • CPU Usage • Memory Usage • Disk Usage • CPU Usage by Protocol Engines • Memory Usage by Protocol Engines • TCP Server Connections • TCP Client Connections CPU Usage The following table describes the CPU Usage chart: Table 128: CPU Usage Chart & Description Chart Description CPU Usage Illustrates the percentage of CPU consumed by a delivery server for the specified time range. Chart Information The information within this chart is shown in an area graph with Date/Time along the X-axis and the CPU usage as Percentage along the Y-axis. The legend representing the graph is Average. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 197 Administration Trend Chart Formula The formula used to derive the graph is: average of CPU usage (%) for the given delivery server. Chart Filters This chart uses Time Range, Delivery Server Group, and Delivery Server as filters. Memory Usage The following table describes the Memory Usage chart: Table 129: Memory Usage Chart & Description Chart Description Memory Usage Illustrates the percentage of memory consumed by a delivery server for the specified time range. Chart Information The information within this chart is shown in an area graph with Date/Time along the X-axis and the memory usage as Percentage along the Y-axis. The legend representing the graph is Average. Chart Formula The formula used to derive the graph is: average of memory usage (%) for the given delivery server. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 198 Administration Trend Chart Filters This chart uses Time Range, Delivery Server Group, and Delivery Server as filters. Disk Usage The following table describes the Disk Usage chart: Table 130: Disk Usage Chart & Description Chart Description Disk Usage Illustrates the percentage of disk consumed by a delivery server for the specified time range. Chart Information The information within this chart is shown in an area graph with Date/Time along the X-axis and the disk usage as Percentage along the Y-axis. The legend representing the graph is Average. Chart Formula The formula used to derive the graph is: average of disk usage (%) for the given delivery server. Chart Filters This chart uses Time Range, Delivery Server Group, and Delivery Server as filters. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 199 Administration Trend CPU Usage by Protocol Engines The following table describes the CPU Usage by Protocol Engines chart: Table 131: CPU Usage by Protocol Engines Chart & Description Chart Description CPU Usage by Protocol Engines Illustrates the percentage of CPU consumed by a protocol engine of a delivery server for the specified time range. Chart Information The information within this chart is shown in a line graph with Date/Time along the X-axis and the CPU usage as Percentage along the Y-axis. The legends representing the graph are Maximum, Minimum, and Average. Chart Formula The formula used to derive the graph is: • Maximum—Maximum of CPU usage (%) for the given delivery server. • Minimum—Minimum of CPU usage (%) for the given delivery server. • Average—Average of CPU usage (%) for the given delivery server. Chart Filters Videoscape Distribution Suite Service Manager User Guide, Release 3.3 200 This chart uses Protocol Engine, Time Range, Delivery Server Group, and Delivery Server as filters. Administration Trend Memory Usage by Protocol Engines The following table describes the Memory Usage by Protocol Engines chart: Table 132: Memory Usage by Protocol Engines Chart & Description Chart Description Memory Usage by Protocol Engines Illustrates the memory consumed by a protocol engine of a delivery server for the specified time range. Chart Information The information within this chart is shown in a line graph with Date/Time along the X-axis and the memory usage as MB along the Y-axis. The legends representing the graph are Maximum, Minimum, and Average. Chart Formula The formula used to derive the graph is: • Maximum—Maximum of memory usage (MB) for the given delivery server. • Minimum—Minimum of memory usage (MB) for the given delivery server. • Average—Average of memory usage (MB) for the given delivery server. Chart Filters This chart uses Protocol Engine, Time Range, Delivery Server Group, and Delivery Server as filters. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 201 Administration Trend TCP Server Connections The following table describes the TCP Server Connections chart: Table 133: TCP Server Connections Chart & Description Chart Description TCP Server Connections Illustrates the number of TCP server connections established in a delivery server for the specified time range. Chart Information The information within this chart is shown in a line graph with Date/Time along the X-axis and Count of TCP server connections along the Y-axis. The legends representing the graph are Maximum, Minimum, and Average. Chart Formula The formula used to derive the graph is: maximum, minimum, and average TCP server connections for the given delivery server. Chart Filters This chart uses Time Range, Delivery Server Group, and Delivery Server as filters. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 202 Administration Trend TCP Client Connections The following table describes the TCP Client Connections chart: Table 134: TCP Client Connections Chart & Description Chart Description TCP Client Connections Illustrates the number of TCP client connections established in a delivery server for the specified time range. Chart Information The information within this chart is shown in a line graph with Date/Time along the X-axis and Count of TCP client connections along the Y-axis. The legends representing the graph are Maximum, Minimum, and Average. Chart Formula The formula used to derive the graph is: maximum, minimum, and average TCP client connections for the given delivery server. Chart Filters This chart uses Time Range, Delivery Server Group, and Delivery Server as filters. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 203 Administration Trend Service Router This tab displays charts that indicates the health of system resources at service router level. To access this tab, from the Home page, choose Administration > CDN Health > Trend > Service Router. The following metrics are displayed here: • CPU Usage • Memory Usage • Disk Usage • CPU Usage for Service Routing • Memory Usage for Service Routing • TCP Server Connections • TCP Client Connections CPU Usage The following table describes the CPU Usage chart: Table 135: CPU Usage Chart & Description Chart Videoscape Distribution Suite Service Manager User Guide, Release 3.3 204 Description Administration Trend CPU Usage Illustrates the percentage of CPU consumed by a service router for the specified time range. Chart Information The information within this chart is shown in an area graph with Date/Time along the X-axis and the CPU usage as Percentage along the Y-axis. The legend representing the graph is Average. Chart Formula The formula used to derive the graph is: average of CPU usage (%) for the given service router. Chart Filters This chart uses Time Range, and Service Router as filters. Memory Usage The following table describes the Memory Usage chart: Table 136: Memory Usage Chart & Description Chart Description Memory Usage Illustrates the percentage of memory consumed by a service router for the specified time range. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 205 Administration Trend Chart Information The information within this chart is shown in an area graph with Date/Time along the X-axis and the memory usage as Percentage along the Y-axis. The legend representing the graph is Average. Chart Formula The formula used to derive the graph is: average of memory usage (%) for the given service router. Chart Filters This chart uses Time Range, and Service Router as filters. Disk Usage The following table describes the Disk Usage chart: Table 137: Disk Usage Chart & Description Chart Description Disk Usage Illustrates the percentage of disk consumed by a service router for the specified time range. Chart Information The information within this chart is shown in an area graph with Date/Time along the X-axis and the disk usage as Percentage along the Y-axis. The legend representing the graph is Average. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 206 Administration Trend Chart Formula The formula used to derive the graph is: average of disk usage (%) for the given service router. Chart Filters This chart uses Time Range, and Service Router as filters. CPU Usage for Service Routing The following table describes the CPU Usage for Service Routing chart: Table 138: CPU Usage for Service Routing Chart & Description Chart Description CPU Usage for Service Routing Illustrates the maximum, minimum, and average percentage of CPU consumed by a service router for the specified time range. Chart Information The information within this chart is shown in a line graph with Date/Time along the X-axis and the CPU usage as percentage along the Y-axis. The legends representing the graph are Maximum, Minimum, and Average Videoscape Distribution Suite Service Manager User Guide, Release 3.3 207 Administration Trend Chart Formula The formula used to derive the graph is: • Maximum—Maximum of CPU usage (%) for the given service router. • Minimum—Minimum of CPU usage (%) for the given service router. • Average—Average of CPU usage (%) for the given service router. Chart Filters This chart uses Time Range, and Service Router as filters. Memory Usage for Service Routing The following table describes the Memory Usage for Service Routing chart: Table 139: Memory Usage for Service Routing Chart & Description Chart Description Memory Usage for Service Routing Illustrates the maximum, minimum, and average memory consumed by a service router for the specified time range. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 208 Administration Trend Chart Information The information within this chart is shown in a line graph with Date/Time along the X-axis and the memory usage as MB along the Y-axis. The legends representing the graph are Maximum, Minimum, and Average. Chart Formula The formula used to derive the graph is: • Maximum—Maximum of memory usage (MB) for the given service router. • Minimum—Minimum of memory usage (MB) for the given service router. • Average—Average of memory usage (MB) for the given service router. Chart Filters This chart uses Time Range, and Service Router as filters. TCP Server Connections The following table describes the TCP Server Connections chart: Table 140: TCP Server Connections Chart & Description Chart Description Videoscape Distribution Suite Service Manager User Guide, Release 3.3 209 Administration Trend TCP Server Connections Illustrates the number of TCP server connections established in a service router for the specified time range. Chart Information The information within this chart is shown in a line graph with Date/Time along the X-axis and Count of TCP server connections along the Y-axis. The legends representing the graph are Maximum, Minimum, and Average. Chart Formula The formula used to derive the graph is: maximum, minimum, and average TCP server connections for the given service router. Chart Filters This chart uses Time Range, and Service Router as filters. TCP Client Connections The following table describes the TCP Client Connections chart: Table 141: TCP Client Connections Chart & Description Chart Description TCP Client Connections Illustrates the number of TCP client connections established in a service router for the specified time range. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 210 Administration Log Event Discrepancies Chart Information The information within this chart is shown in a line graph with Date/Time along the X-axis and Count of TCP client connections along the Y-axis. The legends representing the graph are Maximum, Minimum, and Average. Chart Formula The formula used to derive the graph is: maximum, minimum, and average TCP client connections for the given service router. Chart Filters This chart uses Time Range, and Service Router as filters. Log Event Discrepancies The Log Event Discrepancies illustrates the data loss information for the specified time interval. The charts related to Content and Viewer metrics will not get populated for the day(s) plotted in Log Event Discrepancies chart. You can drill down the data in the chart at granular level. Click on the graph to view the data loss reason and count of missing events on that particular date. Click the corresponding row to view the missing file names. To access the Log Event Discrepancies, from the main page, choose Administration > Log Event Discrepancies. The following table describes the chart available within this dashboard. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 211 Administration Log Event Discrepancies Table 142: Log Event Discrepancies Chart & Description Chart Description Log Event Discrepancies Illustrates the amount of data loss occurred while receiving the transaction log from the universal forwarder. Chart Information The information within this chart is shown as a column chart with Date/Time along the X-axis and Count along the Y-axis. The legends representing the graph are reasons for data loss. Chart Formula The formula used to derive the graph is: total logs missed during log transaction. Chart Filter This chart uses Time Range Picker–Previous day, Last 7 days, Last 30 days, as filter. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 212 CHAPTER 9 Troubleshooting • Troubleshooting Analytics Dashboards, page 213 • Troubleshooting Splunk Licensing Issues, page 214 • Troubleshooting Splunk Forwarder Issues, page 215 • Troubleshooting the Splunk Indexer, page 216 • Troubleshooting the Analytics Search Head, page 217 • Troubleshooting VDS-IS Provisioning, page 219 • Deleting Summarized Data, page 219 • Splunk License Violation, page 220 Troubleshooting Analytics Dashboards The analytics system is a critical tool for troubleshooting run-time issues, as well as providing trending information that can be used for capacity planning and other purposes. If it is not properly operating, the ability to use it for troubleshooting is lost. The most commonly observed behavior of the analytics system that is not working, is a lack of data. If any of the above functions are not operating properly, the Dashboards and Reports data may not appear, and the message “no result found” is displayed. The following list provides possible problems that could arise while using the VDS Analytics: • Splunk licensing • Splunk Forwarder not operating correctly • Analytics Indexer not operating • Search Head not operating Videoscape Distribution Suite Service Manager User Guide, Release 3.3 213 Troubleshooting Troubleshooting Splunk Licensing Issues Troubleshooting Splunk Licensing Issues Depending on the browser being used, either Internet Explorer (IE) or Firefox, Splunk licensing issues may cause different errors to appear. The following are examples of a Splunk licensing errors. • Splunk licensing issues in IE. • Splunk licensing issues in Firefox. In Firefox, an insecurelogin file will start to download. For example: To troubleshoot Splunk licensing issues, perform the following steps: Step 1 Step 2 Copy the Splunk license file to your local machine, taking care to note the location, which will be used later in this procedure. Open the Splunk manager app on the Job Scheduler. Using the following: Example: http://<IP of Job Sched>:8000/en-us/manager Username: Admin or admin Example: Videoscape Distribution Suite Service Manager User Guide, Release 3.3 214 Troubleshooting Troubleshooting Splunk Forwarder Issues Password: Beaumaris1 Step 3 Choose Settings > Licensing. Step 4 Select Add License. Step 5 Browse your machine to the location where you copied the license file. Note: Do not change the filename. Step 6 Select Install. Step 7 Return to the Licensing page and confirm whether the new license is added and is valid. Troubleshooting Splunk Forwarder Issues To verify that the Splunk Forwarder is functioning correctly, ensure that the application node expected to supply data, has an active forwarder. To do this, perform the following steps: Step 1 Step 2 SSH to the Forwarder. Login to the Forwarder using, username: bninet and password: password. Step 3 At the Forwarder prompt, enter the PS command to verify that the Splunk Forwarder is running. For example: Example: [ bninet@FW ~]$ ps eax | grep splunkd | grep 8088 2256 ? Sl 0:52 splunkd -p 8088 start CONSOLE=/ dev /console SELINUX_IN IT=YES SHELL=/bin/bash TERM= linux USER= bninet INIT_VERSION=sysvinit-2.86 PATH=/h ome / bninet / splunkforwarder /bin:/ sbin :/ usr / sbin :/bin:/ usr /bin _=/home/ bninet / splu nkforwarder /bin/ splunk runlevel =3 RUNLEVEL=3 PWD=/ LANG=en_US.UTF-8 previous=N P REVLEVEL=N SHLVL=3 HOME=/home/ bninet LOGNAME= bninet HOSTNAME=FW SPLUNK_HOME=/ hom e/ bninet / splunkforwarder SPLUNK_DB=/home/ bninet / splunkforwarder / var /lib/ splunk S PLUNK_SERVER_NAME= splunkforwarder SPLUNK_WEB_NAME= splunkweb LD_LIBRARY_PATH=/ hom e/ bninet / splunkforwarder /lib LDAPCONF=/home/ bninet / splunkforwarder / etc / openldap / ldap.conf 2257 ? Ss 0:04 splunkd -p 8088 start CONSOLE=/ dev /console SELINUX_IN IT=YES SHELL=/bin/bash TERM= linux USER= bninet INIT_VERSION=sysvinit-2.86 PATH=/h ome / bninet / splunkforwarder /bin:/ sbin :/ usr / sbin :/bin:/ usr /bin _=/home/ bninet / splu nkforwarder /bin/ splunk runlevel =3 RUNLEVEL=3 PWD=/ LANG=en_US.UTF-8 previous=N P REVLEVEL=N SHLVL=3 HOME=/home/ bninet LOGNAME= bninet HOSTNAME=FW SPLUNK_HOME=/ hom e/ bninet / splunkforwarder SPLUNK_DB=/home/ bninet / splunkforwarder / var /lib/ splunk S PLUNK_SERVER_NAME= splunkforwarder SPLUNK_WEB_NAME= splunkweb LD_LIBRARY_PATH=/ hom e/ bninet / splunkforwarder /lib LDAPCONF=/home/ bninet / splunkforwarder / etc / openldap / ldap.conf [ bninet@FW ~]$ Step 4 If Splunk Forwarder is not running, restart it by using the following command. In the following example, a Splunk Forwarder restart example is shown. Example: / etc / init.d / splunkforwarder restart Restarting Splunk ... Videoscape Distribution Suite Service Manager User Guide, Release 3.3 215 Troubleshooting Troubleshooting the Splunk Indexer Password: Stopping splunkd ... Shutting down. Please wait, as this may take a few minutes. . [ OK ] Stopping splunk helpers... [ OK ] Done. Splunk > Needle. Haystack. Found. Checking prerequisites... Checking mgmt port [8088]: open Checking conf files for typos... All preliminary checks passed. Starting splunk server daemon ( splunkd )... [ OK ] Done.touch : cannot touch `/ var /lock/ subsys / splunk ': Permission denied If the nodes are forwarding, there should be constant updates in the splunkd log file located in "/opt/splunkforwarder/var/log/splunk". If the processes are running and the log is not being updated, contact Cisco Customer Support. Troubleshooting the Splunk Indexer Once the Analytic Forwarder is verified to be functioning properly, verify the operation of Splunk Indexer. To do this, perform the following steps: Step 1 Step 2 ssh into the IP address of the Indexer. Using the netstat command, list the monitoring ports. For example: Example: [ bninet@IDX netstat -a 2>>/ dev /null | grep 8089t tcp 0 0 *:8089 *:* LISTEN [bninet@IDX ~]$ Step 3 If there are no jobscheduler processes listening on port 8089, then the indexer is not functioning. Restart the indexer. For example: Example: [ bninet@IDX ~]$ sudo / etc / init.d / splunk restart Videoscape Distribution Suite Service Manager User Guide, Release 3.3 216 Troubleshooting Troubleshooting the Analytics Search Head Restarting Splunk ... splunkweb is not running. Stopping splunkd ... Shutting down. Please wait, as this may take a few minutes. ....... [ OK ] Stopping splunk helpers... [ OK ] Done. Splunk > The IT Search Engine. Checking prerequisites... Checking mgmt port [8089]: open Checking configuration... Done. Checking index directory... Validated databases: _audit _ blocksignature _internal _ thefishbucket cdn-mgr cdnmanager cms dsm history main os summary Done Bypassing local license checks since this instance is configured with a remote license master. Success Checking conf files for typos... All preliminary checks passed. Starting splunk server daemon ( splunkd )... [ OK ] Done. Troubleshooting the Analytics Search Head To verify that the Analytics Node (often referred to as the search head) is operating properly, perform the following steps: Step 1 Step 2 ssh into the IP address of the analytics node. Using the netstat command, list the monitoring ports. For example: Example: [ bninet@IDX netstat -a 2>>/ dev /null | grep 8089 tcp 0 0 *:8089 *:* LISTEN Videoscape Distribution Suite Service Manager User Guide, Release 3.3 217 Troubleshooting Troubleshooting the Analytics Search Head [bninet@IDX ~]$ Step 3 If there are no analytics node processes listening on port 8089, then the nodes are not functioning. Restart Splunk. For example: Example: [ bninet@IDX ~]$ sudo / etc / init.d / splunk restart Restarting Splunk ... splunkweb is not running. Stopping splunkd ... Shutting down. Please wait, as this may take a few minutes. ....... [ OK ] Stopping splunk helpers... [ OK ] Done. Splunk > The IT Search Engine. Checking prerequisites... Checking mgmt port [8089]: open Checking configuration... Done. Checking index directory... Validated databases: _audit _ blocksignature _internal _ thefishbucket cdn-mgr cdnmanager cms dsm history main os summary Done Bypassing local license checks since this instance is configured with a remote license master. Success Checking conf files for typos... All preliminary checks passed. Starting splunk server daemon ( splunkd )... [ OK ] Done. In addition, the command sudo /home/ bninet /splunk/bin/splunk search 'index= dsm | stats count' - auth admin:changeme can be run to show that the analytics node is capable of processing data from the indexer, as shown below. This command sends scrolling data to the screen, which is compressed in the output below: Example: [ bninet@Search ~]$ /home/bninet/splunk/bin/splunk search 'index= dsm | stats count' -auth admin:changeme count ----0 Videoscape Distribution Suite Service Manager User Guide, Release 3.3 218 Troubleshooting Troubleshooting VDS-IS Provisioning Troubleshooting VDS-IS Provisioning The server.log file, located within the /home/bninet/jbossesb/server/default/log/ folder, can be used to troubleshoot VDS-IS provisioning problems. To access the server.log file, perform the following step: ssh into the CDN Manager node and then enter the following command: /home/bninet/jbossesb/server/default/log/server.log Deleting Summarized Data To delete the summarized data, perform the following steps: Step 1 Step 2 Launch the JS node web interface http://<JSipaddress>:8000 Login to the Splunk web interface by providing the credentials; Username: admin and Password: Beaumaris1 Step 3 Select App and then select Search. Step 4 Execute the search query [index=summary report="<Report Name>" host="<JS Host Name>" | delete] Provide the appropriate report name and hostname in the query. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 219 Troubleshooting Splunk License Violation Example: Step 5 [index=summary report=mobitv_client_daily host= secondary-JS | delete] Validate the count by issuing the search query [index=summary report=mobitv_client_daily] Note can_delete role is already added for Admin. However, the above query will not work in a normal search page. Splunk License Violation Violations occur when you exceed the maximum indexing volume allowed for your license. If you exceed your licensed daily volume on any one calendar day, you will get a violation warning. The message persists for 14 days. If you have 5 or more warnings on an Enterprise license or 3 warnings on a Free license in a rolling 30-day period, you are in violation of your license and search will be disabled. Note Summary index volume is not counted against your license. If you get a violation warning, you have until midnight (going by the time on the license master) to resolve it before it counts against the total number of warnings within the rolling 30-day period. During a license violation period: • Splunk does not stop indexing your data. Splunk only blocks search while you exceed your license. • Searches to the _internal index are not disabled. This means that you can still access the Indexing Status dashboard or run searches against _internal to diagnose the licensing problem. For any queries on licensing, contact the Cisco Accounting team. Videoscape Distribution Suite Service Manager User Guide, Release 3.3 220
* Your assessment is very important for improving the workof artificial intelligence, which forms the content of this project
Related manuals
Download PDF
advertisement