AWS S3

 To connect to S3 buckets see the CSV S3 Collector video or read this article.

This articles contains sections on:
Creating an S3 Source 
Editing a Stream Query 
Creating a Stream Query
Recommended Practices

TO CREATE AN S3 SOURCE

  1. In the Data Manager window, click Sources +.
  2. In the Source Types window, click START on the AWS S3 tileS3_icon.ico. The S3 dialog box is displayed.
    S3_bucket_01.png
  3. From the drop-down menu select the AWS regional  bucket location.
  4. Enter the bucket name you created in your AWS account.
    [Optional] To restrict access to a specific folder in the bucket, enter the name of the folder in the Folder Name field.
    Note  To make sure that the bucket policy is updated to enable Anodot to access the files:
    i. Navigate to Bucket Policy in the  Permissions > Bucket Policy in your AWS account.
    New_bucket_policy.png
    ii. Copy the policy listed below, change the "Resource" to your own bucket name.

{
    "Id": "Policy1520872584746",
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "Stmt1520872574434",
            "Action": [
                "s3:Get*",
                "s3:List*"
            ],
            "Effect": "Allow",
            "Resource": [
                "arn:aws:s3:::<bucket-name>",
                "arn:aws:s3:::<bucket-name>/*"
            ],

            "Principal": {
                "AWS": [
                    "arn:aws:iam::340481513670:user/anodot-bc"
                ]
            }
        }
    ]
}

For more details, see AWS Using Bucket Policies and User Policies

5. Click Continue, to display the Stream Query window.

CREATING AN S3 STREAM QUERY

If you have just created an S3 data source, skip to step 3.

    1.  In the Data Manager Source panel, choose the source to which you want to add a stream query; the streams associated to that source are displayed in the Streams panel.
      Note If the Streams panel is empty, no stream queries exist for that source.
    2. Click Streams + to display the Stream Query window.
    3. In the Files Path field enter a path relative to the data source. 
      [Optional] You can further restrict access to the source by continuing the path to a specific folder within the bucket.
    4. Choose a File Name Date Pattern and collection interval:

      Filename Timestamp Pattern

      Example

      Supported Intervals

       yyyyMMdd

      test_20180715_daily.csv.gz

      Daily

      yyyyMMddHH 

      test_2018071503_hourly.csv.gz 
      test_2018071504_hourly.csv.gz 
      test_2018071505_hourly.csv.gz

      Daily, hourly [1]

      yyyyMMddHHmm 

      test_201807150305_5min.csv.gz
      test_201807150310_5min.csv.gz
      test_201807150300_15min.csv.gz
      test_201807150315_15min.csv.gz
      test_201807150330_15min.csv.gz
      test_201807150345_15min.csv.gz

      Daily, hourly,
      15 minutes, 5 minutes [2]


      [1] If daily - the most recent file will be used
      [2] For daily, hourly, 15 minutes, 5 minutes - the most recent file will be used


    5. In the File name prefix field, enter the prefix (e.g. test_ )
    6. In the File name suffix field, enter suffix and extension (e.g. _demo.csv.gz)
      AWS_S3_stream_query_prefix_suffix_australia.png

      Note

      • In each of the Timestamp/Prefix/Suffix fields enter the specified data only.
      • Files may be compressed [.gz]
      • If you get an error message, fix the error in the bucket or files, and click RETRY to re-fetch the files.
    7. To preview the file, clickEyeIcon.ico. [Optional]
    8. To change the Parsing and Import Settings, click File_settings_icon.ico.
      See CSV - Parsing and Importing Settings.
    9. Click GO! The imported Measures & Dimensions are  displayed.
      AWS_S3_no_measures.png

Note If there are no Measures in the Stream Query, an editable Events Count column is automatically inserted in the Stream Table.

EDITING A STREAM QUERY

  1. To edit the Stream Query, click the  Pen icon in the Measures & Dimensions panel. 

    1. S3_MeasuresDimensionsPanel.png
  • To add an item, drag from the repository on the left to the relevant Measure or Dimension  panel. At least one dimension and one measure [ a numerical value] are required.
  • To clear an item, click the X icon on the item.
  • Choose a time format from the drop-down menu.
  • Choose a time zone. 

2. Click X to accept the edits and return to the Stream Query window.

3. To edit the Schedule File Collection, click the Pen icon in the Schedule panel.
S3_Schedule_File_Collection.png

In Schedule File Collection, choose: 

  • From the Collect files every menu, set the collection interval [daily/ hourly/ 15 min/ 5 min].
    Note The timestamp at the start of the source file name indicates the the period of the hourly or daily data. Each row in a file will increase incrementally, either hourly or daily, accordingly. 
  • An Ignore files older than time span.
    Note "Older than" refers to back filing of historical data and does not affect ongoing collection.
  • A File Time Zone for Anodot to know how to relate to the internal timestamp.
  • A Lagging files policy to set the number of intervals to waits for lagging files.

Note  The system behavior in general is to keep the data ordered, and create as minimal gaps as possible. Therefore, the heuristics are the following:

1. While there is no new data, meaning no new files, the system will retry to collect from the last file collected. In this case, the lag policy parameter does not affect anything.
2. When there is a gap followed by new files, the Lagging files parameter is used to state "how many intervals the system should wait before processing the new files". So that the file hold processing is not too long, due to missing files that may never or are too-long in arriving.

Example
File  2018032806_test.csv was collected OK - Anodot has collected the data up to 2018/03/28 at 06:59
The files for 07,08, 09 have not arrived to the relevant folder.
The file for 10, called 2018032810_test.csv arrived at 11:15 - therefore there is a gap.

The Lagging files parameter determines the processing of the 10 o'clock file:

Lag policy = 0 --> The 10 file will be processed upon arrival, and a gap in the previous hours is created.

Lag policy = 1 --> The 10 file will not be processed yet, it will wait to 12:15 and then be processed. [If during the waiting time, older files arrive, they will be processed before.]

Lag policy = 2 --> The 10 file will not be processed yet, it will wait to 13:15 and then be processed. [If during the waiting time, older files arrive, they will be processed before.]

11. Click X to accept the scheduling settings.

12. Click NEXT. The Stream Table is displayed.

RECOMMENDED PRACTICES

Before uploading a data set file to AWS S3 source type:

  1. Prepare the file in a test folder; check that the file format meets the S3 data source file parameters. 
  2. Records within files must be sorted chronologically.
    Note Files smaller than 16MB are automatically sorted by timestamp by Anodot.
  3. Move the file to the production folder only after you have verified that the file is complete.

Note

  • If the file timestamp is epoch seconds or epoch milliseconds, don't define a timezone - it will be treated as an error.
  • The file must be formatted using UTF-8 encoding with ASCII character sets.
  • An S3 bucket can be accessed from one Anodot account.

SEE
Using Data Collectors
Data Manager
Stream Tables
Stream Summaries

Was this article helpful?
0 out of 0 found this helpful
-->