Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • an AWS account with the necessary control over the permissions needed for integration with VidiCore API / VidiNet.

  • a basic understanding of the AWS services such as S3 ( the cloud storage)  and IAM ( the permissions service ) 

  • a verified installation of VidiCore API / VidiNet

  • a verified S3 bucket set up in your AWS account in order to attach this service to VidiNet

Info

Logs including requests can only be obtain by running VidiCore 5.5.1, 5.4.3, 5.3.6 or later.

Table of contents

Table of Contents

...

To create an S3 bucket in AWS, direct your attention to the webpage web page of your AWS account and the Service S3.

...

First, create a new user that should have permission to access this S3 bucket. Navigate to the AWS IAM Service. Click Users and then click the button Add user. Follow the instruction prompted by the dialogue box. Make sure to enable Programmatic Access to this users Access type.

Set S3 Policy

First things first. Before setting up the log destination in VidiNet, you need to change your bucket policy to allow VidiCore to write to your bucket. Open up .

Configure logging in VidiNet Dashboard

The logging is configured from the VidiNet Dashboard. Find the panel named "Log Destination" (see below). 

Select configure and add you bucket name and a folder where you want the logs to be stored. VidiCore will create the folder if it does not exist. The logs will be stored in a folder hierarchy with the format yyyy/MM/dd/<logfiles>. 

...

Select configure and add you bucket name and a folder where you want the logs to be stored. VidiCore will create the folder if it does not exist. The logs will be stored in a folder hierarchy with the format yyyy/MM/dd/<logfiles>. 

Info

VidiCore as a Service will be recycled when applying or removing log destination setting in VidiNet.

Logs will not be removed from S3 upon log destination setting removal in VidiNet.

This operations takes a couple of minutes, during that time your system will be in updating state. Search index will be kept intact and no further initialization is needed.  

When you have created the log destination it will be visible in the panel, allowing you to edit it, or remove it at any time. 

...

Info

Note: Make sure you use different buckets and/or folders for your different Vidispine API instances to avoid mixing up logs in the log folders. 

Set S3 Policy

After log destination is applied in VidiNet dashboard open the AWS console and navigate to Amazon S3 and select the bucket you want to use. The policy is set under Permissions->Bucket Policy (see picture)

...

Code Block
{
   "Version": "2012-10-17",
   "Statement": [
       {
           "Sid": "Statement3",
           "Effect": "Allow",
           "Principal": {
               “AWS”"AWS": “arn"arn:aws:iam::823635665685:role/{vaas-name}-vidispine”vidispine"
           },
           "Action": "s3:PutObject",
           "Resource": "arn:aws:s3:::{your-s3-bucket}/*"
       }
   ]
}

Info

vaas-name is the first part of your VidiCore API endpoint:
Example API endpoint example.myvidispine.com would use vaas-name = example

...

Configure logging in VidiNet Dashboard

The logging is configured from the VidiNet Dashboard. Find the panel named "Log Destination" (see below). 

Select configure and add you bucket name and a folder where you want the logs to be stored. VidiCore will create the folder if it does not exist. The logs will be stored in a folder hierarchy with the format yyyy/MM/dd/<logfiles>. 

...

Select configure and add you bucket name and a folder where you want the logs to be stored. VidiCore will create the folder if it does not exist. The logs will be stored in a folder hierarchy with the format yyyy/MM/dd/<logfiles>. 

Image Removed

Info

Note: Make sure you use different buckets and/or folders for your different Vidispine API instances to avoid mixing up logs in the log folders. 

When you have created the log destination it will be visible in the panel, allowing you to edit it, or remove it at any time. 

Image Removed

Logstash

Once this bucket is configured the logs will start coming into the bucket with the selected prefix. There will be a lot of small log files, which you can for example pick up and make use of with LogStash. The following config can be used to pick up all new files and save them to a local file: server.log, it will also delete processed files to keep your bucket clean. Note that you can use both temporary credentials with a session token or static credentials:

...