FAQ & Troubleshooting

Index

Where Can I Find More Assistance to Run source{d} or Notify You About Any Issue or Suggestion?

If this documentation was not enough, you could also try:

  • open an issue, if you want to

    suggest a new feature, if you need assistance with a contribution, or if you

    found any bug.

  • Visit the source{d} Forum where users and community

    members discuss anything source{d} related. You will find there some common questions

    from other source{d} users, or ask yours.

  • join our community on Slack,

    and talk with some of our engineers.

How Can I Update My Version Of source{d} CE?

When there is a new release of source{d} CE, it is noticed every time a sourced command is called. When it happens you can download the new version from src-d/sourced-ce/releases/latest, and proceed as it follows:

(You can also follow these steps if you want to update to any beta version, to downgrade, or to use your own built version of source{d} CE)

  1. download the new binary for your OS

  2. move the binary to the right place (see Quickstart. Install)

  3. run sourced compose download

  4. run sourced restart to apply the new configuration.

This process will reinstall source{d} CE with the new components, but it will keep your data (repositories, charts, dashboards, etc). If you want to replace all the current dashboards with the ones from the release that you just installed, you have two alternatives:

  • run sourced prune --all before running sourced init; but if you were using

    repositories downloaded from a GitHub organization, they will be deleted, and

    downloaded again.

  • drop only the dashboards, and load the new ones, following also this other

    instructions: How To Restore Dashboards and Charts to Defaults

How To Restore Dashboards and Charts to Defaults

In some circumstances, you may want to restore the UI dashboard and charts to its defaults. Currently, there is no clean way of doing it without deleting all the state of the UI.

Following these steps, all the state modified from the UI (charts, dashboards, saved queries, users, roles, etcetera) will be replaced by the default ones for the version of source{d} CE that you're currently using. If you're using repositories from a GitHub organization, all its data will be preserved, and only charts and dashboards will be restarted.

To do so, you only need to delete the docker volume containing the PostgreSQL database, and restart source{d} CE. It can be done following these steps if you already have Docker Compose installed:

$ cd ~/.sourced/workdirs/__active__
$ source .env
$ docker-compose stop postgres
$ docker-compose rm -f postgres
$ ENV_PREFIX=`awk '{print tolower($0)}' <<< ${COMPOSE_PROJECT_NAME}`
$ docker volume rm ${ENV_PREFIX}_postgres
$ sourced restart

How Can I See Logs of Running Components?

$ cd ~/.sourced/workdirs/__active__
$ docker-compose logs -f [components...]

Where -f will keep the connection opened, and the logs will appear as they come instead of exiting after the last logged one.

Where you can pass a space separated list of component names to see only their logs (i.e. sourced-ui, gitbase, bblfsh, gitcollector, ghsync, metadatadb, postgres, redis). If you do not pass any component name, there will appear the logs of all of them.

Can I Query Gitbase or Babelfish with External Tools?

Yes, as explained in our docs about source{d} CE Architecture, these and other components are exposed to the host machine, to be used by third party tools like Jupyter Notebook, gitbase clients and Babelfish clients.

The connection values that you should use to connect to these components, are defined in the docker-compose.yml, and sumarized in the Architecture documentation

Where Can I Read More About the Web Interface?

The user interface is based in the open-sourced Apache Superset, so you can also refer to Superset tutorials for advanced usage of the web interface.

When I Try to Create a Chart from a Query, Nothing Happens.

The charts can be created from the SQL Lab, using the Explore button once you run a query. If nothing happens, the browser may be blocking the new window that should be opened to edit the new chart. You should configure your browser to let source{d} UI to open pop-ups (e.g. in Chrome it is done allowing 127.0.0.1:8088 to handle pop-ups and redirects from the Site Settings menu).

When I Try to Export a Dashboard, Nothing Happens.

If nothing happens when pressing Export button from the dashboard list, then you should configure your browser to let source{d} UI to open pop-ups (e.g. in Chrome it is done allowing 127.0.0.1:8088 to handle pop-ups and redirects from the Site Settings menu)

The Dashboard Takes a Long to Load and the UI Freezes.

This is a known issue that we're trying to address, but here is more info about it.

In some circumstances, loading the data for the dashboards can take some time, and the UI can be frozen in the meanwhile. It can happen —on big datasets—, the first time you access the dashboards, or when they are refreshed.

There are some limitations with how Apache Superset handles long-running SQL queries, which may affect the dashboard charts. Since most of the charts of the Overview dashboard loads its data from gitbase, its queries can take more time than the expected for the UI.

When it happens, the UI can be frozen, or you can get this message in some charts:

Query timeout - visualization queries are set to timeout at 300 seconds. Perhaps your data has grown, your database is under unusual load, or you are simply querying a data source that is too large to be processed within the timeout range. If that is the case, we recommend that you summarize your data further.

When it occurs, you should wait till the UI is responsive again, and separately refresh each failing chart with its force refresh option (on its top-right corner). With some big datasets, it took 3 refreshes and 15 minutes to get data for all charts.