CB Analytics - User Manual


1. What assumptions do we make?

2. What are the prerequisites?

3 Where do I start?

4 Who is a user?

5 How do I register myself?

6 How long do you keep my account alive?

7 What next?

What assumptions do we make?

That you have done a standard/default install.
  • CloudBuddy analytics is installed in C:\Program Files\CloudBuddyAnalytics\
  • Abyss webserver is running on the default port 8000
  • All access to the CloudBuddy Analytics is using the url http://localhost:8000

NOTE: Your installation might be different and keep those differences in mind while you read through this document.

What are the prerequisites?

Remember that CloudBuddy Analytics is still BETA; but to give you all the needed information, the following prerequisites need to be satisfied.

  • Strawberry Perl
  • Microsoft Visual C++ Redistributable patch
  • A valid AWS account

Where do I start?

You start at the "Start" menu of your Windows machine. Navigate through "All Programs" find "CloudBuddy Analytics", click on "Start Service". This will start the Abyss WebServer. You should see an icon like...

...in your System tray. Now go to your favorite browser, ours is firefox, type http://localhost:8000/awstats/login.pl.

Who is a user?

A user is you, who wishes to use CloudBuddy Analytics to view S3 access statistics; with only the following prerequisite

Has a valid AWS account

How do I register myself?

In order to create your account, you must register a valid AWS account by going to http://localhost:8000/awstats/login.pl, in your browser, and then clicking on .

You are registered, once you fill in the correct details here...

and then click on .

NOTE: User registration is validated against the AWS account and the Account Name is the identifier for that account.

How long do you keep my account alive?

Once you make a valid registration, you could use the same username and password to login and this will remain so until the you choose to uninstall CloudBuddy Analytics- which we guess will not happen; as you would love it.

Caveats
  • You must, at anytime, have at least one account configured.
  • You cannot create many Account Names pointing to one AWS Account
  • The password cannot be changed. Its BETA you see

What next?

Once you have registered, you will be presented with a screen like this.

Henceforth we will call the top blue panel the "TopBar" and lower screen area with the logo "SplashScreen".

TopBar

TopBar is the backbone of all activity. This is where you will interact with CloudBuddy Analytics most often. And we will split this, the TopBar, into three parts. Accounts, Buckets and Logout.

Account

The Account list box will display the Account Name you are currently viewing. When you log in, this will be the last Account Name you configured. The Account Name is a descriptive name for the associated AWS account.

There must be at least one Account you need to be associated with. So, you will not be allowed to remove your last account.

You may choose to add another AWS account by clicking on the . This will pull down the TopBar and you will see this,

And you need to fill in the details.
Click on "Create" to create a new Account. Remember, the account will be created only if the account is validated.

or

Click on "Cancel" to pull up the TopBar

You can choose to remove an Account by clicking next to the accounts list. The associated Account will be removed, but not before you confirm.

Bucket

Once you select an Account, the buckets associated with that Account are listed in the Bucket list.

Viewing the bucket analytics is a two step process.
  1. You must select a bucket and then click on "Subscribe?". The Subscribe is for CloudBuddy Analytics to keep track of all the buckets that you have Subscribed through our tool and nothing more.
  2. Then you need to click on "Show Analytics" link(which will show itself when you Subscribe) to display the stats for any bucket that has logging enabled.

What do you mean "logging enable"?

Yes. In order to see the analytics for a bucket, the logging should be enabled for that bucket. If not, CloudBuddy Analytics will enable it for you and display an Alert saying "it will take some time for logs to pour in, please revisit after couple of hours".

NOTE: CloudBuddy Analytics does not ask before enabling the logs for the selected bucket. We will change this behaviour soon.

Back to Bucket

On clicking "Show Analytics" for a log enabled bucket, you will see a progress screen...

...replace the "Splash Screen" until your reports are displayed. If for a long time you do not see your reports, Please be very patient, they will show up.

To unsubscribe a bucket from CloudBuddy Analytics, Click on the "Unsubscribe?" link.

Logout

To logout from the session you need to click on the "Logout" link. This will take you back to the login screen.